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.

State	Description	Behavior
Licensed	A valid, non-expired license is present.	Pipelines operate normally. Endpoints and transfers are fully operational.
Unlicensed	No 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 Level	License-Related Events
INFO	License successfully applied.
WARN	License approaching expiration. Pipeline state changes due to license enforcement.
ERROR	License missing, invalid, or expired.

License Notifications

UDMG displays a corner toast notification to inform System Administrators, Domain Administrators, and Operators of license issues that require attention. The notification appears once per browser tab session. It does not reappear on page reload unless the browser tab is closed and reopened.

Scenario	Message
No license enrolled	UDMG is unlicensed. Apply a valid license in Global → Settings → Licensing.
License expired	UDMG license has expired. Renew your license in Global → Settings → Licensing.
License expiring in 1-30 days	UDMG license expires in N day(s). Renew your license in Global → Settings → Licensing.
License valid, more than 30 days remaining	No notification is shown.

Error notifications are persistent and must be manually dismissed. The warning notification for an expiring license auto-dismisses after 10 seconds.

If the license status cannot be retrieved (for example, due to a server error), no notification is shown.

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 the following read-only metadata.

info

The license status can also be viewed on the UDMG Status page.

Name	Description
State	The current license state. info The license status can also be viewed by clicking the UDMG Status button at the bottom of the Sidebar.
License To	The customer or organization the license is issued to.
Environment	The environment associated with the license, such as DEV or Production.
Start Date	The date and time the license validity period begins. The license cannot be enrolled before this date.
Expiration Date	The date and time when the license expires.
Days Remaining	The number of days remaining until the license expires.
Created	The date and time when the license was issued by Stonebranch.
Transfers in Current Period	The count of transfers that occurred since the start of the current license period. The current period begins on the most recent anniversary of the Start Date, or on the original Start Date if no anniversary has passed yet. Displays as an integer, or N/A if no Start Date is recorded.
Transfers in Prior Periods	The transfer counts for the three annual periods immediately preceding the current period. Each row shows the period's start and end timestamps alongside the number of transfers that occurred in that window. Displays 0 if the license was active during the period but no transfers were made. Displays N/A for any period that predates the license Start Date (including all three rows on a newly issued license), because no license was in effect during those windows.