Skip to content

Migration from legacy Explorer to next generation Explorer

Edvard Fonsell edited this page Aug 30, 2023 · 2 revisions

nFlow version 8 deprecated nflow-explorer in favor of nflow-explorer-ng. If you use nFlow 8, you can continue using the legacy Explorer without any actions, but it's already recommended to migrate to the next generation Explorer now.

In nFlow version 9, legacy Explorer was removed, and nflow-explorer-ng was renamed to nflow-explorer. When you start using nFlow version 9, you must migrate to the next generation Explorer.

Checklist

  1. nFlow version 8 only: nflow-explorer-ng is deployed the same way as nflow-explorer, so you need to change the dependency name from nflow-explorer to nflow-explorer-ng and use nFlow version 8. Note that nflow-explorer-ng works also with nFlow 7.4.0 API, if you cannot migrate the backend to nFlow 8 for some reason.

  2. Check that your nFlow Explorer config.js is compatible with the configuration options of the next generation Explorer config.js. The overall Explorer configuration options are documented here. Backwards incompatible changes are listed the in the following table.

  3. Note that the Config object in config.js is now defined as new function() instead of function(): var Config = new function() {

Legacy Explorer Next generation Explorer
nflowUrl, nflowApiDocs and withCredentials define nFlow REST API location, and if browser credentials (if any) are sent to the API services nflowEndpoints array defines nFlow REST API location, even if you have only one API, and credentials are sent to API services by default
adal property defines you Azure AD authentication options Azure AD authentication is not supported. Open Github issue if you need it.
radiator property defines how often Explorer polls for updates from the API (e.g. workflow instance refresh, radiator), and how many polled objects are held in browser memory refreshSeconds property defines how often Explorer polls for updates from the API (e.g workflow instance refresh), only the most recent polled object is held in browser memory so radiator.maxHistorySize is removed
queryArchive property defines if the workflow instances are queried also from archive tables queryArchive property is not supported, but will be implemented in future.
searchResultColumns property defines which columns are rendered in workflow instance search result table, and you can add workflow instance state variables as columns All columns in workflow instance search result table are rendered/available, but most of them hidden by default. If user makes them visible, the setting is persisted in browser localstorage. If you define a (by default) hidden column in searchResultColumns, it will become visible by default. As earlier, you can also add workflow instance state variables as columns.
hideFooter property enables you to hide the footer There is no footer in nflow-explorer-ng