Changelog

View the Assimilation Changelog here.

3.1.2

Released 10-12-2018

Upgrading/Bug Fixes

Requires finsemble-react-controls@3.1.2 Please be sure to update your package.json and download the latest.

  • (9822) Fixed hover issues on menu "pins" and "trashcans"
  • (9791) CSS formatting issue with pins on toolbar.
  • (9814) Error preventing tabs and notepads from moving.

3.1.1

Upgrading/Bug Fixes

Requires finsemble-react-controls@3.1.1 Please be sure to update your package.json and download the latest.

(9490) Fixed hover state on dockable toolbar. (9631) Windows that are snapped to the edges of adjacent monitors no longer represent a contiguous group. Pressing the group icon will not link windows that are snapped across monitors.

component.window.dockedHeight now determines the height of a dockable component when docked.

3.1.0

Released 10-09-2018

Major UI Improvements

Dockable Components

Finsemble now supports "dockable" components. When snapped to the edge of a monitor, a dockable component will fill up the edge. Other components will then snap up against the dockable component. Dockable components support the following config:

    window.dockable: ["top","bottom"] // The allowable docking positions.
    docked: "top" // The initial docking position. Leave empty to float the component by default.
    canGroup: false // If canGroup is "false," the component can't be snapped to another component when floating.

Floating Toolbar

The Finsemble Toolbar is now a dockable component. End users can grab the toolbar to undock it from the top of the screen, converting it into a "floating" toolbar. The toolbar can be redocked to the top or bottom of any monitor. In order to enable the dockable toolbar, the following changes should be made to the Toolbar component config. See presentationComponents.json in the latest finsemble-seed project.

        "Toolbar": {
            "window": {
                "dockable": [
                    "top",
                    "bottom"
                ],
                "maxHeight": 39,
                "minHeight": 39,
                "minWidth": 99,
                "docked": "top",
                "canGroup": false,
                "options": {
                    "smallWindow": true
                }
            },
            "component": {
                "spawnOnAllMonitors": false,
                "canMinimize": false
            },
            "foreign": {
                "services": {
                    "dockingService": {
                        "isArrangable": false,
                        "ignoreSnappingRequests": true
                    },
                    "workspaceService": {
                        "global": true,
                        "ignoreTilingAndTabbingRequests": true
                    }
                },
            }

The Toolbar can now be hidden or shown using hotkeys. CTRL+ALT+H hide the Toolbar. CTRL+ALT+T will show the Toolbar. If the Toolbar is floating but hidden behind other windows, pressing CTRL+ALT+T will bring the Toolbar to the front of the screen, positioned directly under the mouse pointer.

Smarter Workspaces

Finsemble is much smarter now when restoring or importing workspaces. If you have a different monitor configuration (fewer monitors, different resolutions, different orientations) then Finsemble will intelligently place windows that might otherwise have slipped beyond the scope of your virtual workspace.

Importing and exporting of tabbed window groups is now supported.

Upgrading/Bug Fixes

This version requires finsemble-react-controls version 3.1. The finsemble-seed package.json has been updated. Please check your own package.json to ensure that it is no longer set for 1.*.

Please note that the default storage adapter in the finsemble-seed project has been changed to the new indexedDBAdapter. Your users will lose their existing workspaces and preferences if you switch from localStorageAdapter to indexedDBAdapter. You should only do so if you're experiencing serious issues with OpenFin's localStorage flush to disk. These generally occur more often in development than in production.

In order to enable the new Floating Toolbar you should make the config changes described above. If you do not change the config, then Toolbar will continue to operate as it always has.

  • (9588) Eliminated stray JavaScript error in UserPreferences.

3.0.8

  • (9351) CTRL+SHIFT+L is now the default hotkey for the Central Logger (in config). Backtick turns out to have a different mapping between US and UK keyboards, and between Windows 7 and Windows 10. It cannot be reliably used as a hotkey.

3.0.7

  • (9525) Fixed bug in localStorageAdapter and indexedStorageAdapter that was unintentionally leaving the storage prefix in responses from keys.
  • (9552) Cleaned up presentation component html that was technically invalid in order to pass linter tests.
  • (9352) Capturing history.replaceState() so that workspaces remember the last navigated page from within a component.
  • (9351) The hotkey for showing the Central Logger is now configurable through finsemble.servicesConfig.logger.hotkeyShowCentralLogger. The default is now CTRL+SHIFT+L. Formerly the default was CTRL+L and could not be disabled.

3.0.6

  • (9517) fsbl-drag-handle moved inside FSBLHeader. This fixes scaling issues when the body is zoomed.
  • (9212) Search filter was not working properly with single character in input box.
  • (9324) Added queuing to indexDBAdapter to handle requests that are received prior to IndexDB being initialized.
  • (9195) Assimilation upgraded to version 2.0.3. On some machines, launching a native application could take longer than 400ms. This caused Assimilation to assume the native app had failed. Instead, we now wait 15 seconds.

3.0.5

  • (9180) Fixed extended "ghost image" when dragging tabs.

3.0.4

  • (7829) Added indexDBAdapter. localStoragedapter is no longer the default because of flush to disk issues with OpenFin. indexedDB does not suffer this same problem.
  • (9132) Components that were vertically scrolled lost the ability to be moved by end users.

3.0.3

  • (8749) Added default splash page to manifest.
  • (8745) Modified toolbar config so that icon has relative path.
  • (8750) Removed unused image assets.

3.0.1

Released 09-05-2018

Removed stray, unused mocha references.

3.0.0

Released 07-25-2018

Version 3.0 represents a significant step toward realizing Finsemble as the integration layer for finance. The build improvements, improved native support, and easier white labeling bring Finsemble closer to being a real production-ready solution for "assemblers," versus an SDK for developers. Simultaneously, the new UI-centric features offer a versatile and powerful toolset to the end user.

Major UI Improvements

Tabbing & Tiling

Finsemble now offers tiling and tabbing as turnkey UI features.

Powerful UI for Power Users: Tiling and tabbing join existing window management features such as snap, dock, group, hyperfocus, bring all to front, minimize all, and auto-arrange features. All of these features automatically function alongside one another, interchangeably. While Finsemble already offers a far more extensive UI than the containers it sits atop, this is now an order of magnitude more so.

Move Over, Phidias: Finsemble’s tiling algorithm takes a page from the Golden Layout. With tiling, users can quickly arrange pieces of workflow into shapes that are both beautiful and functional.

The Desktop, Infinitely Extended: While many existing Finsemble features help address the problem of limited screen real estate, the introduction of tabbing adds an entire new dimension to Finsemble’s UI. Completely separate applications can now exist as tabs within a single window—either alone ala browser tabs or grouped together in some other fashion. In effect, this allows for infinite extension of the workspace.

Tabbing

Tiling

Improved Process Monitor

Finsemble is fast and economical with memory, but there’s no way to guarantee that 1000+ distinct apps that can each run within a Finsemble instance will always behave. In the case where a malfunctioning app is consuming more than its fair share of memory or has become unresponsive, Finsemble now offers a user-facing process monitor as a convenience tool, much like the Windows Task Manager.

The process monitor can be found by accessing the Central Logger. Click on the Finsemble button on the toolbar, launch the Central Logger, and you'll find the Process Monitor button on the top left.

Presentation Component Redesign

Everybody likes to get a makeover every now and then. Finsemble 3.0 sports a thinner, more professional aesthetic.

  • Slicker, low-profile window title bars are now the default.
  • Window scrollbars now appear underneath the Finsemble window title bar.
  • An optional preload zoom.js can be set for components. This will allow an end user to CTRL +/- to zoom. The zoom state will be automatically saved and restored with the workspace.

Companion Window

The companion window is a small HTML5 window that tracks the location of an integrated native app and unobtrusively sits superimposed. Its normal state is that of a tiny tab. It unfurls with a click, becoming a fully functional Finsemble window title bar. The Companion Window can be styled like any Finsemble header, allowing for consistent theming, UI Controls for context sharing, etc.

Two Headers, No Code: The companion window solves two problems. First, it makes good on the promise that native windows can fully participate with Finsemble UI, with no code required. Second, it allows for that participation without obscuring the existing native header (which may contain critical functionality for that native app).

Note: This is an experimental feature. If you have feedback about how the companion window works or should work, feel free to let us know.

Major Framework Improvements

Build Restructuring

Finsemble’s build process has been reorganized with a focus on seamless upgrading. Customers can now take advantage of Finsemble’s rapid release cycle and incorporate the latest Finsemble improvements without disrupting the pace or trajectory of their own project.

Improved White Labeling

In tandem with Finsemble’s restyling work, white labeling has been improved. Finsemble styling is now pure CSS and is carefully abstracted; for most customers, the white labeling process is now as simple as interchanging icons and applying a color scheme. These settings propagate through the entire Finsemble instance—and even into constituent applications.

To this end, the white labeling files and variables have changed. _variables.css and _variablesWhiteLabel.css has been replaced with _theme.css and _themeWhitelabelcss. The new _theme.css file implements a core color scheme (i.e., -primary-font-color, -primary-accent-color). This allows rapid branding by modifying just a few variables. To implement your branding, copy _theme.css to _themeWhitelabel.css and then modify as appropriate. Please contact us if you'd like assistance in migrating your CSS.

Native Support

Native integration has been significantly improved.

Environment Variables: Finsemble's assimilation can now spawn native assets. Set config betaFeatures.assimilation.useOpenFinSpawn=false. One immediate advantage is the ability to set environment variables when spawning a native application. These can be set in the component's config for windowenv.

Example, spawn command prompt with the environment variable "FINSEMBLE" set to true:

    ...
    "components": {
        "Notepad": {
            "window": {
                "id": "CommandPrompt",
                "windowType": "assimilation",
                "path": "cmd.exe",
                "env": {
                    "FINSEMBLE": "true"
                }
            },
            ...

Assimilation 2.0 + Microsoft Lync Support: Assimilation code has been largely rewritten to allow native components to visually integrate more easily into Finsemble UI. Users will also notice a big uptick in performance, particularly when moving large groups of native and Finsemble windows together. Finsemble 3.0 also supports environments that include Microsoft Lync.

WPF Library Extension: Finsemble’s WPF Library has also been extended. Finsemble’s WPF Library allows native apps to make RPC calls to Finsemble. This means that native apps can use essentially the same code for communicating with Finsemble as they do their own local code, so integration becomes easier and faster.

WPF Window Title Bar: Lastly, a layer of polish has been applied to our WPF window title bar. The WPF window title bar looks and feels like the Finsemble window title bar, and it offers the same functionality (linker, drag and drop, etc.) but is written entirely in native code. For customers who want a 100% pure native app without sacrificing any theming consistency, the WPF window title bar provides an easy path.

Persisting URLs

When a workspace reloads, components will now be re-instantiated with the URL from their config. However, the optional config entry persistURL can be used to override this behavior. For instance, you may have a component that allows user navigation. If persistURL is true, then Finsemble's workspace will remember the last navigated location and restore it. This can be useful for components who store their state as URLs with query strings or hash tabs.

Example, set a component to persist the last navigated URL:

    "components": {
        "My Component": {
            ...
            "foreign": {
                "services": {
                    "workspace": {
                        "persistURL": true
                    }
                },

Improved Central Logger

The Central Logger has gotten a big overhaul. The Logger now even includes a built in config viewer. This can be really helpful in viewing the results of dynamic config operations.

Improved VDI Support

Finsemble now has better support for environments with Virtual Desktop Infrastructure, such as Citrix or VirtualBox. VDI presents a cautionary example to any customer who might wish to build rather than buy; a good window and workspace management layer will inevitably (and rudely) jostle with virtual desktops for control of the user’s experience. Finsemble 3.0’s underlying framework has evolved to mitigate the risks posed by the VDI technology used by most institutions.

Bug Fixes

  • Added missing hot key entries for punctuation marks.
  • (7727) Increased size of input boxes in ad hoc (user created) components.
  • (7729) Toolbars will now appear/disappear on multiple monitors if a monitor change occurred while the computer was asleep.
  • (7653) Windows that are closed from the Windows Taskbar are now properly removed from workspaces.
  • (7644) Active "singleton" components are now brought to front if you choose them from the apps menu.
  • (7483) Tabbing or Tiling can now be optionally disabled through configs: "servicesConfig->docking->tabbing->enabled" and "servicesConfig->docking->tiling->enabled".
  • Fixed capitalization issue with MonitorsAndScaling.

Upgrade Info

The gulpfile build process has been substantially refactored. These changes should be transparent to you. You can continue to use npm run dev and npm run dev:fresh. Extending the gulpfile is now substantially easier. Please refer to gulpfile-extensions.js for instructions on how to do so.

The folder /src-built-in/components/assets has been moved to /assets. This eliminates the need to maintain two separate assets folders for src and src-built-in. The relative paths of the assets have been changed in all import, link, and img tags within src-built-in and config files. You will need to modify these paths for your own configs and custom components. To modify the paths, search across files for ../assets and then change the number of "../" as appropriate.

"finfont" files have been renamed "font-finance".

Tabbing and tiling can be disabled using the finsemble["Window Manager.showTabs"] config. This can be done both globally and per component.

When a workspace is loaded (or the app starts), windows will obtain their URL from their component config. Sometimes, however, you may have a component that should retain its former URL. For instance, if a user navigates in the component, the URL may reflect the state of the component. For such components you can set the config item component.foreign.services.workspace.persistURL to true in order to retain their prior URL. You can also set the global servicesConfig.workspace.persistURL.


2.5.11

Released 7-11-2018

Upgrading/Bug Fixes

(7982) Shutdown wasn't occurring quickly enough. This caused localStorage to sometimes not update (resulting in workspaces and central logger changes not retaining state). This also caused .net/WFP applications to miss their shutdown signals. Taskbar icons were showing up as individual icons instead of as a group of icons.

2.5.10

Released 7-03-2018

Upgrading/Bug Fixes

(7779) Fixes to allow native components (using finsemble.dll) to shut down cleanly (7822) config imports were limited to 10. This has been changed to 10 levels of recursion.

2.5.9

Released 6-28-2018

Upgrading/Bug Fixes

(7503) Don't print assimilation version notification error if assimilation is not enabled.

2.5.8

Released 6-27-2018

Upgrading/Bug Fixes

(7653) Fixed error that caused workspaces to fail when reloading an [Openfin] application

2.5.7

Released 6-22-2018

Upgrading/Bug Fixes

Fixed syntax error in openfinWindowWrapper.js

2.5.5

Released 6-18-2018

Upgrading/Bug Fixes

(7535) Mind control was not being injected into cross-domain components.

(7540) spawnData was not being passed to cross-domain components.

2.5.3

Released 6-06-2018

Upgrading/Bug Fixes

(6963) "windowType" : "application" will now open an OpenFin application as a component.

(6963) Cross domain windows automatically open as new "applications". This allows them to display in process monitor (previously they wouldn't show up).

2.5.2

Released 5-30-2018

Upgrading/Bug Fixes

Upgrade Info

(7022) Notifications can now be styled with CSS variable overrides. See variables that begin with -notification-* in src-built-in/assets/css/_variables.css. Override these variables in your _variablesWhitelabel.css file.

(6773) We've cleaned up the dependency chain for Finsemble, cutting down to only fourteen runtime dependencies for the core library and seven for the seed project. For many firms, this will speed up data security sign-off.

Bugs and Small Improvements

(6590) Default hotkeys for bring to front and minimize all were changed from CTRL+SHIFT+UP/DOWN to CTRL+ALT+UP/DOWN. The prior key chords were overriding Excel.

(6760) Input dialogs now receive focus automatically when they are launched. This requires an upgrade to finsemble-react-controls.

(6882) User-created (ad hoc) components are now successfully saved and restored to workspaces.

(7067) Fixed a bug wherein undocking a single window from a group would cause the entire window group to undock.

(6758) Windows that are closed from the Windows taskbar weren't being removed from workspaces (they would come back next time you loaded the workspace).

(6846) Assertion code was added to prevent FSBL.onReady() from firing twice. This can occur in rare conditions where OpenFin preloads twice, or situations where a developer manually includes FSBL even when it was preloaded. This introduces subtle state bugs in many components. If this assertion violation is detected, Finsemble will make a best effort to rectify and will present a notification alerting the developer to the issue.

(6473) Connection errors to assimilation are now detected via timeout and presented to the developer as a notification. This can cause a "white toolbar" problem that is difficult to detect without proactive notification.

2.5

Released 5-16-2018

Notifications

Finsemble now supports notifications. These are the fun toast messages that pop up from the bottom right corner of your screen. We provide a semantical interface for notifications. For instance, you can specify that a particular notification should only occur once, or only occur X number of times. You can also specify that a notification belongs to a particular "topic." In future releases, we'll let you turn on or off topic streams by config; this will allow you, for instance, to load up on developer notifications in a development environment, but turn them off during production.

Notifications

We've included a snazzy notification template. Simply send a notification object containing "description" and "title" fields and our template will do the rest. You can copy this template and make your own as well. One of the cool things about these notifications is that they are plain HTML, so unlike your operating system's notifications you can make them interactive.

Finally, we've started lacing the core Finsemble code with notifications for critical errors. So if, for whatever reason, Finsemble doesn't start, you should now get a notification instead of having to pore through log files. Once we introduce topic filtering we'll provide more useful system notifications so that you can quickly spot bugs and inconsistencies.

"Always On Top" icon

This release introduces pinning capability to components by way of the "Always On Top" icon. When the icon is toggled, the window remains on top (like a sticky note). The icon is not included by default, but you can turn it on system wide by adding a global configuration:

"Window Manager" : {
    "alwaysOnTopIcon": true
}

...or you can turn it on for individual components:

"Welcome Component": {
    "foreign: {
        "components": {
            "Window Manager": {
                "alwaysOnTopIcon": true
            }
        }
    }
}

We've also added an optional "Always On Top" icon for the toolbar. It can get annoying when the toolbar slips behind other windows. Click on the pin to force the toolbar to float above all other windows. Currently the pin is enabled with a toolbar configuration. In src-built-in/components/toolbar/config.json, look for this entry:

     {
        "comment": "Change align to add AlwaysOnTop capability",
        "align": "none",
        "type": "reactComponent",
        "reactComponent": "AlwaysOnTop"
    },

Always On Top Toolbar

Change the value of align to either left or right to position it on the toolbar. We'd like your feedback on this feature to determine how to improve it.

Restart timer

Finsemble now has the ability to automatically restart itself at a particular time of day. This can be set as a config entry for all users which can be overridden by a user preference. That preference can be set in a user's preferences screen.

The config entry should be formatted:

scheduledRestart {
    "hour": 16,
    "minute": 30,
    "dialogTimeout": 10000
}

Hours should be in twenty-four hour time according to the user's local machine's time zone.

When it is time to restart, the user is presented with a dialog to confirm or cancel. Since resets often occur at night while the machine is unattended, most often the dialog will time out and Finsemble will reset. The dialogTimeout specifies how long to wait for a user response in milliseconds.

Improved window management

End users have long had the ability to pin their favorite components to the toolbar for ease of access. Now, when an end user SHIFT + clicks on a pinned item on the toolbar, all windows of that type are brought to front. For example, if a user has ChartIQ's charting component pinned to their toolbar, a simple SHIFT + click will bring all charts to the front of their screen.


2.4.2

Released 5-9-2018

Process Monitor

A new Process Monitor component is available located in src-built-in. This component acts a bit like the Windows Task Manager, except that it's focused on applications running in Finsemble. From here you can tell how much CPU and memory each application is using. Also, like Windows Task Manager, you can terminate specific windows or applications (just be careful!).

You'll see this component in the seed project's Apps menu. It's your decision whether you think it will be a good tool for end-users, but it's definitely a very handy tool for developers—a great companion to the Central Logger.

The Process Monitor

Native Overrides

This release also includes a nativeOverrides.js preload file. This can be used to "monkey patch" the browser's built in window.open and window.alert calls. The window.alert call is annoying because it creates an ugly pop-up and, because it's a synchronous call, it freezes the entire application. Most components don't use alerts, but if you encounter one, you can use the nativeOverrides.js to squash that behavior.

Likewise, some applications call window.open for pop-outs. You can use nativeOverrides.js to capture these calls and funnel them through Finsemble's API so that pop-out windows gain a header, window management, and workspace awareness.

You can find the file in src-built-in/preloads/nativeOverrides.js. Look inside for instructions on how to use the overrides.


2.4

Released 4-27-2018

The New

Java support

Finsemble now supports Java apps! This required a lot of elbow grease to work out the kinks. Wouldn't you know that every running Java app looks like "java.exe"? That makes life difficult when you're trying to restore them into a workspace. Apps opened through Java Webstart with command line arguments will now fall into place within restored workspaces.

WPF Window Title Bar

On the subject of native apps, we're proud to announce a new window title bar for native applications applications. Simply include finsemble.dll and your application will gain a window title bar that is identical to the title bar in your HTML5 components. This title bar allows your native components to participate in Finsemble’s window management (snapping, docking, grouping). It also provides direct access to Finsemble RPC, so that you can access Finsemble API commands directly from your C# application. You can get access to finsemble.dll and learn how to use it in this public repo: https://github.com/ChartIQ/finsemble-dotnet-seed

You can also set the title of a component (what appears in the title bar) from the config:

"foreign": {
   "components": {
      "Window Manager": {
          "title": "What a Cool Component"
      }
    }
}

Work/home balance

One of the big differences between desktop apps and web apps is that desktop apps tend to be long lived. Users leave them running for hours, days, even weeks. Computers are locked, put to sleep, or go into hibernation. Finsemble now revives properly when a computer wakes from slumber. It also adapts when you plug and unplug monitors. Go ahead, run your app at work, snap the clamshell closed, and reopen it at home on a different monitor. Your Finsemble app will still be running smoothly.

The Improved

CSS overhaul

In 2.4, the CSS has been totally overhauled to be semantically optimal. You will no longer find font-family scattered all over the place, or references to colors in the CSS. Everything is now derived from well defined CSS variables, all of which can be found in a single location: src-built-in/assets/css/variables.css. These variables can be overridden by copying these files to your src directory. This should make it easier for the components that you build to have consistent styling.

Additionally, we've changed the styling of header bars to be much smarter. Want a skinny header bar now? Just change the CSS and Finsemble will automatically adapt.

To that point, we've eliminated SASS! (No, that's a good thing.) Chrome now supports CSS variables which means that we no longer need to rely on a preprocessor to create semantically meaningful CSS. This has been a particularly pesky problem because the good folks who built node-sass leaned heavily on the libsass C++ module, making node-sass heavy. Good riddance we say.

Note: If you need SASS for your own project (maybe your components are built with SASS) then you'll need to add it to gulp-extensions.md and defaultWebpackConfig.js.

Improved white labeling

Branding your Finsemble application has now become super straightforward. All you need are three files in the src-built-in/assets/css directory. These are all blank, ready for you to add branding:

  • fontIconWhitelabel.css - If you'd like to override any of the Font Finance font-icons, simply use this file. Go ahead, load your own fonts!
  • variablesWhitelabel.css - This lets you quickly apply branding to your application. Just copy any styles from variables.css into this file and change them to suit.
  • styleWhitelabel.css - This is the final CSS file that gets loaded, and so you have the opportunity here to override any built-in Finsemble CSS. Want a few pixels wider margin? A splash of color? Go for it.

Check out the tutorial for more details..

This does mean that the presentation components have been overhauled to make use of the new styles. If you've modified any of these components and they no longer look right, let us know and we'll help you migrate.

Improved Central Logger

The Central Logger has received a UX upgrade. Its ease of use has been meaningfully improved.

Deprecated package-lock.json

We got rid of package-lock.json from the project. If you haven't yet been burned by this file—consider yourself lucky. When you run npm install though, it will come back. You can stop it from being generated here.

2.3

Released 4-2-2018

Upgrade with Extensibility Finsemble 2.3 provides a path forward for upgrading your Finsemble framework while keeping all your development work intact. We now provide hooks where you can add customizations to the gulpfile build and not fear that these will be lost during future upgrades. Likewise, we've restructured the webpack build process so that Finsemble's built-in components (such as toolbar) are separated from the components that you've created. This makes upgrades seamless. Finally, we're now including migration scripts with each release so that you can automatically upgrade your build environment with minimal work. Upgrading is easy—starting now.

Go Speed Racer! We've streamlined and parallelized Finsemble’s start-up processes. This means that your Finsemble application will now start 20% faster than it did previously.

We’ve also restructured the build process in the Finsemble seed project! Rapid iteration is a reality with a ten-fold improvement in build times (yes, seriously).

Deprecated: Hot reload has been temporarily disabled with this release as a way to improve build times. We may reintroduce this feature in a future release.

Authentication Profiles The Authentication API been expanded to support "authentication profiles" that allow components to trigger authentication actions dynamically during the runtime of an application. An authentication profile is a config for a particular authentication endpoint and a particular authentication protocol. For instance, imagine you brought up a Salesforce component. That component can use the Authentication API to log in when the component is launched. The Authentication API now includes integrated support for OAuth2, making it super easy to connect to identity providers and OpenID providers.

Deprecated: "isAuthEnabled" - Instead, you now set up an authentication profile called "startup". See the Authentication Tutorial for information.

Native Improvements The RPC Service has been expanded. Native components now have access to the Launcher Client and the Authentication Client. Native clients can now also serve as the initial component that performs authentication (replacing defaultAuthentication).

Flash Finsemble now supports components written in Adobe Flash. Party like it's 1999.

Configuration Verification Finsemble now checks for required config items, and verifies that they are valid types (string, object, etc.) during start-up. It will now spit out a helpful error that can prevent one of those multi-hour "d’oh!" debugging sessions.

Polishing the Seed Tutorial The Finsemble seed project is the best path for developers new to Finsemble waters to get their sea legs. We spent some time providing additional refinement to the seed project tutorial, which you can see here.

2.2

Released 3-2-2018

The New

ChartIQ knows that workflows are the thing that users actually care about. With Finsemble 2.2, we bring additional tools for end users so they’re empowered with customized, elegant workflows.

Search: This release delivers the Search API Client. Since your application’s infrastructure will be unique to your organization, our search architecture and returned results are very pluggable. For instance, you could plug in an elasticsearch instance or security master to power your search. To facilitate this, the Search API Client provides federated search results: it can search each installed provider and display unified results that your users can act on.

  • This automatically includes search across apps and workspaces.

Hotkeys: We added a number of global hotkeys!

  • Components can register for a callback when a hotkey is pressed, even if the app is not in focus.
  • Finsemble provides automatic support for assigning hotkeys to launch components.

User Preferences: We’ve implemented user preferences in Finsemble. Users can now:

  • Import and export workspace templates. This allows users to create and share the configurations that are most effective for their workflows and share them.
  • Rename workspaces.
  • Create new workspaces based on a template.
  • Specify which workspace will load on start-up.

Additionally, developers can now create UI that allows users to overwrite application-level config with their own preferences.

The Improved

Native Apps: We’ve participated in an ongoing effort to have Finsemble coordinate the actions of all your apps, whether they’re native applications or HTML5. Assimilated components now have equal footing with all other components.

UX Improvements: We’re continuing to polish our UX until it’s squeaky clean.

  • App Suites: We've implemented the ability to have developer-defined groups of windows that can be brought into focus with a click.  

  • ALT+TAB: Grouped windows now possess a single icon, allowing users to ALT+TAB between groups.  

  • Bring All Windows to Front: The toolbar now has a “Bring All Windows to Front” button. Users can now bring related components to the front together, even if they are not spatially adjacent on the desktop. Groups can be summoned by Linker channel, or by shared window identifiers.  

  • Drag and Drop Pins: Pinned workspaces and components can now be reordered on the toolbar via drag and drop.  

  • Hyperfocus: Users can also minimize all windows that aren’t related by SHIFT+Clicking on the 1) Dock icon 2) Reveal App Suit icon or 3) Linker Channel color.  

  • Minimize All: The toolbar now has a “Minimize All” button.  

It’s important to note that all UX improvements work with native apps!

Storage Service: The Storage Service can now utilize “topics,” allowing developers to determine where their data is saved. This allows developers to save some data locally and other data to the network.

2.1

Released 2-1-2018

This release is certified with OpenFin version 8.56.26.50.

The New

Take a Walk on the Client Side: Finsemble breaks down the borders between windows on the desktop. With Finsemble, developers can create a deep level of interaction between disparate applications using client-side integration. Release 2.1 introduces two new tools to help developers coordinate HTML5 and native applications: the Storage Adapter and the RPC Service.

By default, calls to the Storage API save data to localStorage by way of a Storage microservice. However, the Storage microservice can be adapted to suit your purposes with, well, a Storage Adapter. If you want to utilize a data store besides localStorage—such as a cloud or network based name/value store or database—you can simply create Storage Adapter to interface with that data store and plug it in. We added the default Storage Adapter for localStorage to our seed project repo so developers can clone it and spend some time tinkering.

The RPC Service grants the functionality of the Linker Client to assimilated native applications (e.g., WPF forms, .Net components, Java apps) so that they can synchronize with HTML5 components. For instance, a native component can be linked by stock symbol with an HTML5 component. Now, interoperability is even easier between HTML5 and native desktop components.

The Ecosystem Evolves: The best in fintech is becoming available through Finsemble. Both Salesforce, a leading CRM, and Symphony, a secure chat client, are now part of the Finsemble ecosystem.

Salesforce Contacts, Accounts, Opportunities, and Leads are available within Finsemble as individual components. These components can share data with one another or external third party applications through our Linker API. Salesforce components can also be primed to listen for external activity (such as a phone call or a chat message) and can automatically log that activity as a task for the appropriate Salesforce record.

Symphony contact lists and chats have been primed with Finsemble code, allowing Symphony to serve as a central hub. Advanced charts, research reports, etc., can be shared in a Symphony window via drag and drop. Likewise, Symphony activity can trigger an event in another component—such as a request-for-quote workflow.

The Improved

  • Assimilation: We fine-tuned the behavior for snapping, docking, and moving grouped assimilated windows.
  • Workspace Service: The Workspace Service now supports restoring assimilated components.
  • Storage Service: We included support for the newly-minted Storage Adapter.
  • WindowClient: Finsemble components are injected with a Finsemble window header bar. Previously, this addition might discombobulate a component if it makes heavy used of fixed CSS styles. Now, a custom header can be injected with optional CSS to allow for better compatibility with more sites. The header can also be delayed until after startup.
  • Presentation Components: The App menu now dynamically resizes to accommodate ad hoc components added by the user.
  • Miscellaneous: Finsemble now automatically adds the "finsemble" class to the root "html" element of all components. Designers can use the existence of this class to know that their application is running on a desktop, and respond with appropriate styling and layout.

2.0

Released 12-01-2017

We’re pleased to present Finsemble 2.0. This release is a culmination of significant new features, performance improvements, and API enhancements. Though the Finsemble dev team is always iterating, this release is a significant refinement of the tools provided to create multi-window desktop applications. We've also integrated with OpenFin's V8 release, leveraging the advantages therein.

Sample Presentation Components

To show how simple it is to customize components, we’ve created a suite of UI controls built with React. Each control provides a single piece of UI functionality, like checkboxes or drop-down menus. Using these controls, we assembled an array of sample components called presentation components. These presentation components are built like every other Finsemble component, and offer a beautiful out-of-the-box UI. Use the sample components wholesale for your Finsemble application, customize them for your own needs, or use them as templates to build your own.

The New

A host of new features show off the real power that comes from using Finsemble:

  • Distributed Store: Finsemble now uses a distributed store data storage mechanism, which solves the "one to many" state management problem. With Finsemble’s distributed store, developers don’t even need to learn the Finsemble API to start building multi-window desktop apps.

  • Dynamic Configuration: Finsemble can now configure itself on the fly. For instance, menus can be configured based on the results of an authentication or entitlements process. Developers can provide component configurations entirely through API calls if they desire.

  • Central Logger: The Central Logger is a unified console for viewing messages across all components and services. The Central Logger will help engineers effectively debug operations that occur across multiple windows.

  • Assimilation: You can now bring any external application into Finsemble using the Assimilation API. For situations where a deep integration is not desired or feasible, Assimilation allows you to quickly manage (launch, move, dock, and group) external desktop apps within your Finsemble application.

The Improved

We’ve fine-tuned the Finsemble framework in a number of ways:

  • Process Splintering: We’ve implemented splintering, a performance feature that lets Finsemble distribute its memory and CPU footprint across multiple OpenFin browser processes. This allows Finsemble to run lots of powerful components simultaneously. Splintering also isolates components so that the entire application can’t be affected by a single badly behaving piece of code.

  • Snap and Dock Improvements: Snapping and docking responsiveness is improved, with better real-time tracking to provide much smoother window movement along with improved snapping behavior.

  • Start-up Time Improvements: We continue to focus on performance improvements across the system. Most notable for 2.0, initialization time for the FSBL preload script has been reduced by 60%.

  • Hot Reload: We’ve added the ability to hot reload your Finsemble components, reducing your built-test cycle during development. This was implemented through Webpack by adding custom middleware to the component build process that allows your changes to appear instantly.

  • Multi-Monitor Bug: Fixed some bugs related to how Finsemble supported adding and removing multiple monitors.

  • Window Dragging Bug: Fixed an edge case where Finsemble "misses" an attempt to click and drag a window.

  • Minding our Ps and Qs: Good code is supported by good documentation. We’ve been cleaning up and improving our documentation so it’s easy for developers and code-crafty people to understand the choices we’ve made and the functionality we’ve implemented.


1.4.0

Released 11-03-2017

Drag And Drop Client

Drag And Drop Client is out of beta. Documentation. Tutorial. With very little code, users can:

  • Drag and drop data between components using the drag icon. Auto-highlight windows that can and cannot receive data.

  • Drag and drop items from within components

  • Easily share dropped data over applications like chat

  • Automatically use the linker to open linked windows or open pre-linked windows with shared data

New Beta Features

  • UI Controls - Substantial additional granularity for UI customization
  • Splintering - Allows splitting of components into separate processes
  • Hot Reload - Developers can see their changes in real time, without restarting the application
  • Dynamic Configuration - Finsemble can now configure itself on the fly (for instance, by user authentication)
  • Central Logger - Allows easier debugging and error logging across components

Core Changes

  • ConfigClient.get() parameters changed
  • Improved performance of dialogs created using DialogManager
  • LinkerClient now uses the distributedStoreClient, internally boosting performance
  • Improved workspace saving performance

Core Additions

  • Added system tray icon

CLI

  • Angular support in the CLI
  • Improved CLI error handling

Premium Component Updates

  • More consistent styling
  • Less resource intensive charting

Bug Fixes

  • Config macro (replacement of strings starting with $) bug fixes
  • Launcher Service crash on invalid URLs in config fixed
  • Fixed a minor docking edge case
  • Fixed an error with workspace restoration

1.3.0

Released 09-18-2017

Docking

Docking is out of beta

  • Window edges snap to each other and the monitor edges
  • Resizing by grabbing snapped window edges and corners resizes all snapped windows together

  • Snapped windows that form a rectangle resize proportionally as a group from the outside edges

  • Snapped windows show a dock icon and clicking the icon will dock all connected windows together
  • Docked windows move as a group

  • Outer rectangular boundary of docked groups snap to other windows, groups and monitor edges

New Beta Features

  • Data Store Client Beta: A data store similar to Facebook's Flux that can be used across components, clients, and services and fires events on data changes
  • Drag And Drop Client Beta: New Finsemble Client that allows for easy dragging and dropping of data between components

Sample Component Updates

  • Fixed issues with menu automatic sizing
  • Added ability to customize toolbar and menu items via config
  • Toolbars and Menus load faster

Core Changes

  • Breaking Change: FSBL.Clients.StorageClient.get now returns what you save. If you send in a string, you receive a string back. If you save an object, you get an object back. If you are using the storageClient, make sure to remove any JSON.parse calls inside of your callbacks.
  • Breaking Change: FSBL.Clients.LinkerClient functions now require a windowIdentifier instead of a windowName to allow the linker to work across separate Finsembleized applications (different uuid).
  • Linker window performance improvements
  • Improved overall component loading performance

Core Additions

  • External OpenFin applications can be spawned using Finsemble. See the updated spawn tutorial.
  • FSBL.getVersion(cb) will now return the Finsemble Version.

CLI

  • Ability to generate mind control components using the cli

Bug Fixes

  • Several workspace saving and restoration bugs fixed
  • Fixed issues with Finsemble window header that caused some windows to not be movable from some spots on the window header.
  • Fixed focus issues with dialog manager created dialogs


1.2.0

Released 07-25-2017

  • Bug fixes.
  • Added a way to quit a Finsemble application: simply call FSBL.shutdownApplication().
  • New onShutdown event. This event allows for components to register cleanup actions to be completed on application quit. For more, see the Finsemble Lifecycle.
  • New onReady event for any client that uses the baseClient. You now can add FSBL.Clients.WindowClient.addEventListener('onReady', cb). This is unlikely to be used unless you're creating a custom component. Note: We still have FSBL.addEventListener('onReady', cb).
  • Configuration Enhancements

    • Openfin manifest now modifiable in the seed project at configs/openfin/manifest-local.json
      • Config variables (e.g. $applicationRoot) supported in JSON config files for added flexibility
      • See updated Configuration tutorial for more information.

    Special Note: If you customize your seed-project's environment, please review the configuration notes at the bottom of the tutorial gettingFinsemble

  • Finsemble-CLI has a new command: finsemble-cli kill. This will kill node processes that our build process spins up, as well as any lingering OpenFin processes.
  • Mind control improvements:
    • Can now specify an array of files to include in your components - Documentation
  • Toolbar and App Launcher enhancements - Documentation
    • Toolbar config now has a menuItems property to customize the items on the Toolbar
    • App launcher can now filter elements shown dynamically

1.1.0

Released 07-05-2017

Changed

  • Bugfixes and performance improvements.

Added

  • Documentation updates
  • Alpha version of assimilation
  • LauncherClient improvements (e.g., better handling of monitor-connections/disconnections)
  • Allow all system components to be turned off (e.g., menus, dialogs, etc.)

Enabling Assimilation

To turn on assimilation, you will need to modify two files.

  1. First, you need to make sure that the The betaFeatures.assimilation property in configs/application/config.json matches the config below:

    "assimilation": {
     "enabled": false,
     "appAssets": [
         {
             "src": "/hosted/assimilation.zip",
             "version": "1.0.2",
             "alias": "assimilation",
             "target": "CppWindowsHook.exe"
         },
         {
             "src": "/hosted/putty.zip",
             "version": "1.0.0",
             "alias": "putty",
             "target": "putty.exe"
         }
     ]
    }

    The appAssets property is an array of external assets that are bundled and delivered with your application. The first application in the array above is our application that brings native windows programs into Finsemble's snapping and docking; it also allows you to bundle your own applications and have them participate in the workspace. The second application is simply an example. To open it, launch NativeTest from the "Apps" menu on the toolbar.

  2. Make sure that finsemble-seed/server/FinsembleConfigs.js matches what's on GitHub, https://github.com/ChartIQ/finsemble-seed/blob/master/server/FinsembleConfigs.js.

The major changes here are bandaids. Soon we will allow you unfettered access to the OpenFin manifest. Since it is currently unavailable in the seed project, the code we've added will prepend your application's baseURL to your external assets. If you want to host assets on another server, simply put the full path in the src property of your external asset. We assume that any external application without http in its src is hosted alongside the rest of the application files (e.g., http://localhost:3375/yourSubDirectory/hosted/externalAsset.zip).

  1. To add your application to the app launcher, make sure the config below is in your components.json file. Replace the alias property, the key, and the id with information related to your native application.
    "NativeTest": {
     "window": {
         "id": "NativeTest",
         "native":true,
         "alias": "putty",
         "path":"",
         "url":"",
         "defaultHeight": 600,
         "autoShow": true,
         "alwaysOnTop": false,
         "resizable": true,
         "showTaskbarIcon": false,
         "contextMenu": true,
         "addToWorkspace": true
     },
     "component": {
     },
     "foreign": {
         "services": {
             "workspaceService": {
                 "isArrangable": true
             }
         },
         "components": {
             "App Launcher": {
                 "launchableByUser": true
             },
             "Window Manager": {
                 "persistWindowState": false,
                 "FSBLHeader": true
             }
         }
     }
    }
    If you get stuck trying to add your own application, send us a note at support@finsemble.com or send us a message on slack.

1.0.0

Released 06-30-2017

This is the first official release of Finsemble.

New Features

  • Snapping windows: Windows now snap to monitor edges and to each other, making it quick and easy for users to assemble their ideal workspace. Snapping is automatically enabled (supported by a new service "dockingService").

  • Mind Control: Allows JavaScript to be injected at run-time into select components. You can use this JavaScript to modify the behavior of the component by interacting with the FSBL API. See the Mind Control tutorial for more information.

API Changes

  • Support for storage adapters now allow developers to save data to locations other than localStorage. Also, the Storage Client is enhanced. See the Storing Data tutorial for more information.

  • LauncherClient has been significantly revised to make component launch more flexible. The new model uses a paradigm based off of CSS div positioning, with the capability of targeting specific monitors or launching components in positions relative to other components. A new "windowIdentifier" paradigm allows windows to be referenced more flexibly. Components can now be set to spawnOnStart and spawnOnAllMonitors. They can also generically make claims on monitor space - to support building custom toolbars. See LauncherClient#spawn and LauncherClient#showWindow API calls.

    These are breaking changes from the Beta release - any calls to spawn() should be rewritten to use the new parameters.

  • The RouterClient now dynamically selects an underlying transport. For cross-domain components (i.e. components not on the same domain as the Router Service) an OpenFin-Bus transport is selected. For same-origin components a faster ShareWorker transport layer is selected. With these enhancements, RouterClient initialization is no longer synchronous, requiring a call to RouterClient.onReady() before using other Router method; however, this is transparent to components that only access the RouterClient though the FSBL object (i.e. the RouterClient is preinitialized in FSBL).

    These are potentially breaking changes from the Beta release - application should either use the RouterClient in FSBL (or for services inheriting from the baseService, reference the preinitialized this.RouterClient) or call RouterClient.onReady() before invoking other router methods.

  • WindowClient now offers fitToDOM() method that allows a window's height to automatically be resized to fit its DOM contents. This is useful for elements such as menus that have variable height.

  • A new ConfigClient provides run-time access to Finsemble configuration. See the Configuration tutorial for more information. If you participated in the Beta and wish to retain you project, then your config files will need to be modified to the new format. See "Upgrade Steps" below.

  • The Finsemble Toolbar is no longer required. If you would like to disable, simply remove the ToolBar entry under components in configs/application/config.json.

New Beta Features

  • Window grouping: Snapped windows "fuse" to form window groups. A window group can then be moved by the end user, for instance from one monitor to another monitor. Window grouping is undergoing user testing and is released as a beta for feedback. To enable window grouping set the docking.enabled flag in the configs/application/config.json file. We're currently working out the kinks in this feature, it should be enabled by default in the coming weeks.

  • Assimilation: Allows Finsemble to launch native applications from the toolbar which participate in snapping and workspaces. See the Assimilation tutorial for more information.

Other Improvements

  • Adaptable Blotter from http://www.adaptabletools.com/ is now available as a Finsemble component!
  • Auto Arrange can now be reversed with a second click.
  • The build process (npm run dev) has been improved to increase speed.
  • Application startup time has been improved.
  • Support for OpenFin version 7.x
  • Finsemble is now loaded via OpenFin's "preload" capability. This means that it is reliably available on any component, even cross domain!

Upgrade Steps

  1. Copy your custom services/components/clients that you've built during the beta period into another folder.
  2. Update your seed project. We've made many enhancements to the build process and configuration files - too many to give you a clean step-by-step upgrade process. A fresh clone from GitHub should be all you need to do.
  3. Delete from under your user directory AppData\Local\OpenFin\cache.
  4. Copy your files from your temporary folder back into their respective folders inside of ./src/.
  5. Make sure that your terminal is logged in to NPM.
  6. run npm install.
  7. run npm update -g @chartiq/finsemble-cli;
  8. run npm run dev.

If you have problems, contact us.



0.4.1

Released 05-19-2017

  • Added placeholder and hooks for authentication. See the Authentication tutorial for instructions on building your own authentication component. The tutorial also includes information on disabling authentication.
  • The authentication placeholder (i.e. the included sample code) prompts for username and password on startup. All storage is now keyed off the username, so the configuration of the application is determined by the entered username (new usernames automatically become new users). The password field is ignored in the placeholder...any password works.

0.4

Released 05-02-2017


0.3.1

Released 04-21-2017

Minor bug fixes

Fixes

  • Direct chat component to the correct URL.
  • Fix some icons issues in the toolbar and windows taskbar.

0.3.0

Released 04-19-2017

You may be wondering, "Where is 0.2?" The short answer is that Brad messed up bumping the NPM version. So 0.3.0 is what we're working with. Hope you enjoy the new features!

Added

  • User defined components - Through the App Launcher, a user can now add their own components (Your own web pages,Google, CNN, etc.) and see them in the App Launcher.Currently, these do not persist in workspaces.
  • Allow developers to set UUID, Port, and host for local, dev, staging, and prod environments.
  • Added way for users to add storage adapters.
  • Added support for hosting Finsemble apps on relative paths.
  • Cleaned up top-level API responses (you should parse response instead of response.data inside of API Calls. If responding to a router request, still parse response.data).
  • Workspaces can be pinned.
  • New look and feel for the toolbar, window header, and dialogs.
  • bug fixes.

Changed

  • Documentation fixes.

Migration steps

We're aware that making changes to your project's structure is a huge pain - we certainly don't intend on making this process commonplace. For this release, however, there are several changes to the underlying application bootstrapping/build process.

There are two paths to migration:

  1. Copying the components that you've already created into a fresh copy of the seed project, or
  2. Modifying your project to match the new configuration.

Copying Components

  1. Clone the seed project into a different folder.
  2. Run npm install.
  3. run npm update -g @chartiq/finsemble-cli
  4. Use the CLI to create your components.
  5. Copy src/components from your old seed into the root of your new project.

Try to run npm run dev. Contact us if this doesn't work and we'll jump on a call to figure out what isn't set up properly.

Modifying your existing project.

  1. Replace src/node_fileserver/FinsembleConfigs.js with the file in the seed project on the master branch.
  2. create configs/startup.json; copy contents from the master branch of the seed project and put in the desired port/hostname configuration.
  3. Modify gulpfile.js

    • On line 9 paste var StartupConfig = require("./configs/startup");. Make sure to update any locations using a port number to the use startup config.
    • Replace line 143 (configPath inside of the launchOpenfin command) with configPath: StartupConfig[env].serverConfig.
    • In the gulp task devServer change launchOpenfin() to launchOpenfin("dev") Also, change all launchOpenfin function calls to the correct environment. The will match up to your startup config.
  4. run npm install.

  5. run npm update -g @chartiq/finsemble-cli;
  6. run npm update @chartiq/finsemble;
  7. run npm run dev. If it doesn't work, contact us and we'll jump on a call with you.

We apologize for the extensive changes. It's unlikely that we'll do this to you again.

The Finsemble Dev Team.

Misc Integration notes:

  1. If you have components from a previous release, that you based on our tutorial on building an application, make sure to remove this rule from your CSS.
* {
    display: block;
}

If you don't, you'll get some lovely CSS plastered on the background of your component's DOM.

  1. If you're playing with accountList/accountDetail from the tutorial, make sure your call to LauncherClient.getActiveDescriptors parses response instead of response.data.