JS7 ships with an Open Source License and a Commercial License, for details see the JS7 - License article.

  • There is no license expiration if the Open Source License is used.
  • Commercial licenses can expire, for example in the case of annual subscriptions.

The following information applies to the use of Commercial Licenses only.

Licenses and Operating Modes

A major difference in operating modes of Controller, Agents and JOC Cockpit is in place:

  • Controller
    • A Standalone Controller can be operated with an Open Source License and with a Commercial License.
      • If the Commercial License expires then the license key can be removed from the Controller and the Controller can be restarted to continue with the Open Source License.
      • This includes continuing any orders running with Standalone Agents.
    • A Controller Cluster can only be operated with a Commercial License.
      • If the Commercial License expires then a Controller Cluster will stop working. A Controller Cluster cannot be migrated. Instead, a Standalone Controller has to be installed.
      • This means that a new journal is used by the Standalone Controller and that submitted orders will be lost. Workflows and related objects still can be re-deployed from JOC Cockpit.
  • Agents
    • Standalone Agents will continue to work with a Standalone Controller if the Controller's license file is removed.
    • Cluster Agents will stop working if no valid Commercial License is in place with the Controller. This applies to both use of a Standalone Controller and of a Controller Cluster.
  • JOC Cockpit
    • A Standalone JOC Cockpit instance can be operated with or without a Commercial License.
    • A JOC Cockpit Cluster will stop working if a Commercial License expires. No automated fail-over and no manual switch-over of JOC Cockpit instances is available.

License Check

On start-up of Controller and JOC Cockpit instances a license check is performed. Users can click the JS7 logo that is available from the upper left hand part of any JOC Cockpit view.

The About JS7 window displays the following information:

  • License Type: Open Source License / Commercial License.
    • The Check License link can be clicked to force a license check and to update information in this window.
  • License Validity: Start date and expiration date of a Commercial License. There is no validity period for the Open Source License.
  • JOC Cockpit: the release information of JOC Cockpit including build number, release number and release date.

The license check takes account of the availability of license key files in the JETTY_BASE/resources/joc/license directory.

  • The directory can hold a number of license keys that are added from .pem or .crt certificate files.
  • During a license check the JOC Cockpit will apply the license key that is valid for the current date and which specifies the expiration date that is furthest in the future.
    • Users can add a license file to the indicated directory and can use the Check License link to force a license check.
    • A number of license files can be present in this directory. License files with newer license keys can be copied to this directory and will be applied with the next license check either on startup of the JOC Cockpit or by use of the Check License link.
  • If a license file is not found in the indicated directory then use of the Open Source License is assumed.

License Expiration Warnings

if a license is about to expire then JOC Cockpit will display warnings like this:


  • 1st warning: An initial reminder about license expiration is displayed 2 months before expiration.
  • 2nd warning: A repeated reminder becomes visible 1 month before expiration.
  • 3rd warning: A final reminder becomes visible 24 hours before expiration.
  • Users have the option to click the Got it link to make the warning disappear or to click the Remind me later link that postpones the warning for 24 hours.

Users who do not wish to receive license expiration warnings can disable this feature from the JOC Cockpit Settings page:

The disable_warning_on_license_expiration setting in the joc section can be assigned the value true to disable warnings about license expiration.

License Expiration Errors

If a license exceeds its expiration date then this is displayed in a red popup window in the lower right hand part of JOC Cockpit views.

In this situation the cluster functionality of JOC Cockpit, Controllers and Agents stops working.

  • The Manage Controllers/Agents page will not allow:
    • management of Controller Clusters,
    • management of Agent Clusters.
  • Standalone Agents can still be managed from the JOC Cockpit. However, a Controller configured for cluster operation will not perform any operations on Agents.

What to do if the License Key did expire?

Further Resources

  • No labels