Skip to main content
Version: 3.3

Licensing

UDMG requires a valid license key to enable file transfer functionality.

The license controls whether Pipelines and transfers are operational. Without a valid license, the UDMG Admin UI remains accessible for configuration, but file transfers are not allowed.

To obtain a license, contact your Stonebranch representative. If you do not have a representative, reach out to support@stonebranch.com.

Before You Begin

License States

UDMG operates in one of two states based on the presence and validity of a license.

StateDescriptionBehavior
LicensedA valid, non-expired license is present.
  • Pipelines operate normally.
  • Endpoints and transfers are fully operational.
UnlicensedNo license is present, or the license is invalid or expired.
  • All local and remote file transfers are disabled.
  • API operations related to Pipelines and Endpoints are not functional.
  • The UDMG Admin UI remains accessible.

License Expiration Behavior

Each license has an expiration date determined by the terms of your contract.

To view the license expiration date, see the License Details section below.

When a license expires, UDMG automatically transitions to the Unlicensed state.

A Stonebranch representative will reach out to you as your license approaches expiration to assist with renewal. If you have any questions about your license or renewal process, contact your Stonebranch representative.

warning

Make sure to renew your license before it expires to avoid disruption to file transfer operations. There is no grace period after license expiration. When a license expires, transfers are immediately disabled.

Logging and Warnings

You can monitor the UDMG logs for license-related events and warnings. These logs can help you stay informed about the license status and take action before any disruption occurs.

UDMG provides logging and warning notifications related to licensing at the following log levels:

Log LevelLicense-Related Events
INFOLicense successfully applied.
WARN
  • License approaching expiration.
  • Pipeline state changes due to license enforcement.
ERRORLicense missing, invalid, or expired.

Behavior After License Update

When a valid license is applied, UDMG transitions to the Licensed state. Any transfers and associated components that were previously non-functional due to licensing become functional again.

If an invalid license is submitted, an error message is provided.

Applying a License

A license can only be applied in the Primary Domain by a System Administrator or Domain Administrator.

To apply or replace a license, follow these steps:

  1. From the Sidebar, click Global > Settings.
  2. Click the Licensing card.
  3. Complete the Key field with the provided license key.
  4. Click Update.

After submission, the license is validated immediately and UDMG transitions to the appropriate state (Licensed or Unlicensed).

info

Applying a valid license automatically restores transfer functionality if it was previously disabled due to license expiration.

Viewing License Details

Only Users with System Administrator, Domain Administrator, or Operator Role can view license details.

To view license details, follow these steps:

  1. From the Sidebar, click Global > Settings.
  2. Click the Licensing card.
  3. Review the Details tab, which includes the license key content and read-only metadata.
info

The license status can also be viewed by clicking the UDMG Status button at the bottom of the Sidebar.

License Details Metadata

The Details tab displays the following read-only license information:

NameDescription
State

The current license state.

License ToThe customer or organization the license is issued to.
EnvironmentThe environment associated with the license, such as DEV or Production.
Start DateThe date and time when the license becomes valid.
Expiration DateThe date and time when the license expires.
Days RemainingThe number of days remaining until the license expires.
CreatedThe date and time when this license record was created in UDMG.