Deploying Notification Center in an enterprise

Once you have set up Notification Center and configured your app to send notifications, you are ready to ship it. Here are instructions for deploying Notification Center in a large organization.

Prerequisites

You must have at least the following versions of OpenFin software:

  • RVM: 6.0
  • Notification Center app: 0.12.10
  • Notification Center npm library: 0.12.10

📘

Note

Versions of Notification Center older than 0.12.10 use the service model for notifications, which is deprecated.

Managing versions through desktop owner settings

In the absence of specific configuration, OpenFin RVM launches the most recent stable version of Notification Center. You can manage the version of Notification Center through an entry in desktop owner settings. This strategy enables you to determine what version of Notification Center your end users receive and to control the roll out of new versions,

You can control the version of Notification Center being run on the desktop with an entry like the following.

{
  "desktopSettings": {
    "openfinSystemApplications": {
      "notifications": {
        "version": "2.0"
      }
    }
  }
}

The RVM uses this entry to find the appropriate version of Notification Center to launch. That means that the desktop owner chooses when to update the Notification Center app, not the app owner.

Desktop owner settings can be as simple as a single static JSON file hosted somewhere on your network. However, to control what version different sets of users access, you might want to create multiple settings files.

Multiple desktop owner settings files

Because desktop owner settings are configured through a registry key, you can have multiple static files, and direct an individual user to a specific one. For example, you can have a production version of Notification Center for most of your users, a pre-production version for beta testers, and a third developer version for your developers.

To deploy a new version of Notification Center, you must do the following:

  1. Change the version number in the settings file that a given set of users access.
  2. Wait for (or force) the users to reboot. They will begin using the new version after reboot.

You can do the same steps to roll back to an earlier version of Notification Center. In that case, it is a good idea to forcibly close the Notification Center app, so that users revert to the older version immediately.

Self-hosting

If you are at an organization that hosts OpenFin assets internally, you can do the same with Notification Center. The RVM reads the assetsUrl value and appends the path to the manifest for the Notification Center app:

<assetsUrl-value>/release/system-apps/notifications/app.json

If you have specified a version in desktop owner settings, the appended path includes the version, like this:

<assetsUrl-value>/release/system-apps/notifications/<version>/app.json

This capability means that you can copy the assets from the OpenFin CDN and install them at the location you chose for assetsUrl. Note that you must change the url entry in the manifest (app.json) so that it points to the location where you installed the files.

Configuring desktop owner settings

If you configure Notification Center directly in the desktop owner settings, you can provide an assetsUrl value there, instead of in a separate manifest.

{
  "desktopSettings": {
    "openfinSystemApplications": {
      "notifications": {    
          "version": "2.0",
          "assetsUrl": "https://myhost/path",
      }
    }
  }
}

Did this page help you?