Local HTTPS Server (WTC)

A Local HTTPS Server (WTC) is a type of Endpoint that represents an HTTPS server that the system hosts locally to provide the Web Transfer Client (WTC), a web-based interface that allows partners to securely upload, download, and manage files directly from a web browser.

This Endpoint type provides basic configuration and customization options, serving as the Source Endpoint within a Pipeline of type UDMG as HTTPS Server.

info

There can only be one Local HTTPS Server (WTC) Endpoint per Domain. Multiple Pipelines can be created to route partner Accounts to the desired folder structure with the desired permission set.

Before You Begin

WTC Configuration

Besides creating a Local HTTPS Server (WTC) Endpoint and a UDMG as HTTPS Server Pipeline, the Web Transfer Client (WTC) service must be enabled and properly configured in the wtc block of the Configuration File.

This global configuration defines the listener address, HTTPS port, and TLS certificates used by all WTC across every Domain.

For detailed instructions, see Setting Up the Web Transfer Client (WTC).

UI Customization

The Local HTTPS Server (WTC) Endpoint allows customization of the WTC login page and interface. Users can tailor the appearance and presentation of the WTC to match organizational or partner branding requirements.

Customizable elements include:

• System Identifier Label: Text displayed on the top of the login page identifying your company, department, or system.
• System Disclaimer Label: Optional legal or informational notice displayed at login (for example, a terms-of-use statement).
• System Version Label: Optional text to indicate the current release or version of the system.
• Custom Logo: An image displayed on the login page.

These customizations affect only the WTC web interface and do not change the functional behavior of the Endpoint or associated Pipelines.

Adding an Endpoint

To add an Endpoint, follow these steps:

1. From the Sidebar, select Configuration > Endpoints.
2. Click Add Endpoint.
3. Select Local HTTPS Server (WTC) in the Endpoint Type dropdown.
4. Complete the Name and Description details for the new Endpoint.
5. Complete the optional UI customization fields.
6. Select whether Accounts with Standard Authentication are allowed to change their passwords through the WTC.
7. Click Add to create the Endpoint.
8. Click Validate to confirm that the IP address and port combination is not already in use by another service (across all Domains). See Validating the Configuration.
9. Click Start to launch the WTC. See Starting, Stopping, and Restarting Endpoints and Setting Up the Web Transfer Client (WTC) for additional information.

warning

UDMG allows creating identical Endpoints with unique names, but this practice is strongly discouraged due to potential downstream complications.

Field Descriptions

The following table describes the fields that are configured for the Endpoint:

Name	Description	Specifications	Required
Endpoint Type	Select Local HTTPS Server (WTC) to expose an HTTPS web interface (the WTC) where your partners can upload and download files.	The type cannot be changed after creation.	Yes
Name	The name of the Local HTTPS Server (WTC) Endpoint.	Must be unique. Must follow the Standard Naming Pattern.	Yes
Description	The description of the Local HTTPS Server (WTC) Endpoint.		No
Allow Password Change	When enabled, Accounts with Standard Authentication can change their passwords via the WTC.	Default is Enabled.	Yes
Auto-Start Endpoint	Endpoint's auto-start status. See Auto-Starting Endpoints.	Default is Enabled.	Yes
System Identifier Label	Optional text shown on the top of the login screen that identifies your company, system, department, organization, etc.		No
System Disclaimer Label	Optional text shown on the bottom of the login page, such as a legal disclaimer, terms of use, or relevant links.		No
System Version Label	Optional text to indicate the current release or version of the system.	Default = latest release number (UDMG-3.2.0).	No
Custom Logo	Custom Logo shown on the login page and within the WTC.	Accepted formats: jpg png gif svg Max size: 1 MB.	No

Editing an Endpoint

To edit an Endpoint, follow these steps:

1. From the Sidebar, select Configuration > Endpoint.
2. Click the Name field of the Endpoint you want to edit.
3. Click Stop above the Endpoint details. As noted above, configuration changes only take effect following an Endpoint restart or stop/start cycle.
4. Click Edit above the Endpoint details.
5. Edit details for the Endpoint, using the Field Descriptions table as a guide.
6. Click Update.
7. Click Restart or Stop/Start.

info

Configuration changes remain inactive until the Local HTTPS Server (WTC) Endpoint is restarted and the Account disconnects/reconnects to its client.

After changes are made, restart the Endpoint to apply the changes. All active connections are terminated.

Managing an Endpoint

The Local HTTPS Server (WTC) Endpoint has multiple management capabilities that allow you to manage and validate the Endpoint.

Viewing Endpoint Details

To view the details of an Endpoint, follow these steps:

1. From the Sidebar, select Configuration > Endpoint.
2. Click the Name of the Endpoint you want to view.
3. Additionally, click the Pipelines tab to see all the Pipelines the Endpoint is associated with.

Endpoint Metadata

Endpoint details include all parameters given in the Field Descriptions table, plus the following read-only metadata:

Name	Description
UUID	Universally Unique Identifier of this Endpoint.
Version	Version number of the configuration. Every change increases the number.
Created	Date and time this Endpoint was created.
Updated	Date and time this Endpoint was last updated.
Test Status	Status of the Validate Endpoint configuration test. Options: Test not executed Test passed Test error
Runtime Status	The status of the server Endpoint. Options: Running Stopped Error: listen tcp 0.0.0.0:2041: bind: address already in use
Active Sessions	The number of active sessions or connections opened with the Endpoint (i.e., Accounts connected to the Endpoint).

Validating the Configuration

The configuration can be validated to confirm if the Local HTTPS Server (WTC) Endpoint's IP Address/Port combination, configured in the wtc block of the Configuration File, is used by another service (across all Domains). It is important to note that, even if a port is not being used elsewhere in UDMG, it is not necessarily available.

To validate the configuration, stop the Endpoint first (click the Stop button) and then click the Validate button. One of the following messages appears:

• Error/Fail: 'Endpoint test has failed. The port #### on address #.#.#.# is already in use.'

  • If validation fails, then the IP Address/Port is not available and should not be used. You must review and modify the IP Address/Port combination.

    info

    If the Endpoint's Runtime Status is Running, then the validation test will fail because the IP Address/Port is being used by that Endpoint.

• Pass: 'Endpoint has passed the test.'

  • If validation passes, the IP Address/Port is not currently being used by another service.

    info

    The test does not confirm if the IP Address/Port can be used by the Endpoint. The IP Address/Port must be available based on your network IT controls, such as firewalls.

Starting, Stopping, and Restarting Endpoints

Local HTTPS Server (WTC) Endpoints function as virtual servers that require proper management for file transfer operations. After initial creation, these Endpoints must be activated before they can process transfers. Endpoints can be initiated through one method:

• Manual Start: Click the Start button on the Details page.

Additionally, configuration changes only take effect following an Endpoint restart or stop/start cycle. Once the Endpoint is running, three control actions are available from the Details page:

• Start: Launches the Endpoint connection when currently stopped.
• Stop: Initiates the shutdown of the Endpoint. New connections are not allowed, while the pending sessions remain until they are disconnected. Utilize the Active Sessions field on the Details page.
• Restart: Executes a complete stop/start sequence to apply configuration changes.

After the initial server creation and initiation, the Endpoint has a Runtime Status indicator that shows the real-time operational state of the server. The current status determines which management actions can be performed. The current state (Runtime Status) of each Local HTTPS Server (WTC) Endpoint is displayed in the Endpoint Record Table and Details page with the following statuses:

• Starting: Server is starting, but not operational yet.
• Running: Server is operational and processing connections.
• Stopped: Server is not running. Especially after a Stop request, it is possible that sessions remain until they disconnect. Utilize the Active Sessions field on the Details page.
• Error: listen tcp 0.0.0.0:2041: bind: address already in use: Server's IP/Port is in use on another Endpoint (across all Domains).

Auto-Starting Endpoints

Local HTTPS Server (WTC) Endpoints can be configured for auto-start functionality, allowing them to launch automatically if the UDMG server is stopped after initial creation or upon startup of the UDMG server. This setting is established during Endpoint creation and can be modified later.

• Enabled: The Endpoint automatically starts without manual intervention after the UDMG server is stopped (Auto-start active).
• Disabled: The Endpoint remains inactive until manually started after the UDMG server is stopped (Auto-start inactive).

To set an to auto-start, follow these steps:

1. From the Sidebar, select Configuration > Endpoints.
2. Click the Name of the Endpoint you want to update.
3. Click Edit.
4. If the Endpoint is currently auto-started, you can remove the auto-start feature by moving the toggle to the left.
5. Click Update.

info

The Auto-Start Endpoint status is reflected as the Enabled field on the Details page.

Deleting an Endpoint

To delete an Endpoint, follow these steps:

1. From the Sidebar, select Configuration > Endpoints.
2. Click the Name of the Endpoint you want to delete.
3. Click the Delete button above the Endpoint details.
4. You will be asked to confirm the deletion. Click Delete.

warning

UDMG prevents the deletion of a Configuration Item if it is currently referenced by another Configuration Item (i.e., Pipeline). The Configuration Item must be edited or the reference removed before you can delete the Endpoint. Deletion cannot be undone.