Skip to main content

Local Filesystem to Remote FTP(S) Server

The Local Filesystem to Remote FTP(S) Server Pipeline enables UDMG to act as an FTP(S) client, pushing files from the local UDMG filesystem to an external FTP(S) server.

This Pipeline consists of:

Before You Begin​

Prerequisites​

Before configuring this Pipeline, we recommend you first:

  • Obtain your partner's FTP(S) server connection details from their administrator, including hostname, port, and authentication credentials.
  • Identify your local source directory and ensure that UDMG has the necessary permissions to read files from it.
  • Test network connectivity to your partner's FTP(S) Server and manually verify that authentication succeeds.
  • Prepare API integration setup and have a UDMG User with domain-level permissions.

Understanding Paths in This Pipeline​

When configuring a Local Filesystem to Remote FTP(S) Server Pipeline, several path fields determine where files are read from locally and where they are written to on the external FTP(S) server.

Each path has a specific role and is combined during runtime to build the complete source and destination paths used in transfers.

Paths Concatenation in Local Filesystem to Remote FTP(S) Server Pipelines

Depends on the domain_chroot argument defined in the Configuration File, which specifies the base path UDMG prepends at runtime. Valid argument values are:

  • NONE: No path is added.
  • WORKDIR: The file path is resolved relative to the work_directory_path argument defined in the Configuration File.
  • WORKDIR+DOMAIN: Same as WORKDIR, but UDMG also prepends the Domain name. For example, if the work_directory_path is /home/udmg/ and the Domain name is primary, the resulting path portion is /home/udmg/primary.
info
  • Default value for domain_chroot is WORKDIR+DOMAIN.
  • Default value for work_directory_path is /home/udmg/.

External FTP(S) Server Authentication​

Pipelines where UDMG acts as a client—more specifically, those that contain a Remote FTP Server Endpoint—require credentials to authenticate with the external FTP(S) server.

Unlike Pipelines, where UDMG acts as the server and relies on Accounts to supply credentials, these Pipelines define credentials directly within the Pipeline configuration.

This design enables each Pipeline to manage its own client authentication credentials independently. As a result, each Pipeline can only authenticate with one external system and use one distinct Credential Type at a time.

Transfer Initialization via Scheduled API​

When UDMG is acting as a client, each transfer must be explicitly scheduled and triggered through the Transfers Scheduled API, considering the configuration provided at the Pipeline level, the Endpoint level, and the HTTP request.

You must first create the Pipeline using the Field Descriptions below, providing Endpoint-specific information.

From there, to initiate a Transfer, you must submit an API request using the API Endpoint with the Pipeline name, the location and name of the file on UDMG to be transferred, and the execution timestamp.

Optionally, you can provide a specific destination path for where the file is to be transferred. Transfers can be executed in real-time or scheduled for a specific future time.

This design enables precise control over file movement and allows each Transfer to be dynamically customized and scheduled.

API Endpoint​

Path​
POST /api/v1/domains/${UDMG_DOMAIN_NAME}/transfers

Request Body​

The request body includes the following fields:

KeyDescriptionFormatRequired
pipelineName of the Pipeline.Exact match to the Pipeline's Name field.Yes
whenDate and time of when to execute the file transfer. If a date in the past is provided, then the Transfer is initiated after the next system pending transfer check (transfer.check_interval parameter is defaulted to every minute). Must be in RFC3339 format ("2025-01-01T00:00:00Z"). Yes
sourceThe exact path where the file to be transferred exists on UDMG locally. The parameter is appended to the Pipeline's associated Root Path and Relative Path to create a full path. The full path is work_directory_path + Root Path + Relative Path + source parameter. If the file is located in a subdirectory, then add it to the parameter.Format: /[subdir]/[filename.ext] or /[file name.txt]Yes
destinationThe path where the file is to be transferred to on the external FTP(S) server. The parameter is appended to the Pipeline's Virtual Path to create a full path. The full path is Virtual Path + destination parameter. If the file needs to be added to a subdirectory, then it should be added to the parameter. If the file needs to be transferred to a subdirectory, include the subdirectory in the parameter.Format: /[subdir]/[filename.ext] or /[same or new file name.txt]No

Example: Full Configuration and Path​

UDMG GlobalSource Endpoint Path 1Source Endpoint Path 2Pipeline Path 1Pipeline Path 2Pipeline Scheduler API Parameter 1Pipeline Scheduler API Parameter 2
API Parameterwork_directory_pathpathtmprelativevirtualsourcedestination
GUI Field-Root PathTemporary PathRelative PathVirtual Path--
Examplehome/udmg/data-/August/Taxes/Form1000.dat/Received/Form1000.dat

  • Resulting Source Path (full): /home/udmg/data/August/Form1000.dat

  • Resulting Destination Path (full): /Taxes/Received/Form1000.dat

Example: Schedule a File Transfer via API​

Use the following curl command to schedule a file transfer through the Transfers Scheduled API:

curl http://<UDMG_HOST>/api/v1/domains/${UDMG_DOMAIN_NAME}/transfers \
   -X POST \
   -H "Content-Type: application/json" \
   -d '{
       "pipeline": "Pipeline_Supplier",    
       "when": "2025-07-03T15:43:52.344Z",    
       "source": "/Form1000.dat",   
       "destination": "/Received/Form1000.dat"   
   }'

Example: Response (Transfer Scheduled)​

Use the following curl command to view the list of scheduled transfers.

    curl http://<UDMG_HOST>/api/v1/domains/${UDMG_DOMAIN_NAME}/transfers/scheduled \
    -X GET \
    -H "Content-Type: application/json" 
{
    "id": 1,
    "pipeline": "Pipeline_Supplier",
    "username": "robi",
    "source": "/data/August/Form1000.dat",
    "destination": "/Taxes/Received/Form1000.dat",
    "schedule": "2025-07-03T15:43:52.344Z",
    "status": "Completed",
    "executedAt": "2025-08-22T20:44:02Z",
    "completedAt": "2025-08-22T20:44:02Z"
}

Adding a Pipeline​

To add a Local Filesystem to Remote FTP(S) Server Pipeline, follow these steps:

  1. From the Sidebar, select Configuration > Pipelines.
  2. Click Add Pipeline.
  3. Complete the Name for the new Pipeline.
  4. Select the Source Endpoint with a Local Filesystem Endpoint type.
  5. Select the Destination Endpoint with a Remote FTP Server Endpoint type.
  6. Fill out the dynamic fields following the Field Descriptions table.
  7. Click Add.
warning

UDMG does not allow for the creation of identical Pipelines (even with unique names). The Pipeline must pass the Source Endpoint + Destination Endpoint + Permissions + Virtual Path uniqueness check. See Pipelines for more information on Pipeline validation checks.

Field Descriptions​

NameDescriptionSpecificationsRequired
NameName of the Pipeline.Yes
DescriptionDescription for the Pipeline.No
Source Endpoint

The Source Endpoint is where files are retrieved, originated, or come from.

Allowable Source Endpoints are based on the available Pipeline combinations.

Yes
Destination Endpoint

The Destination Endpoint is where files are delivered to or sent.

Allowable Destination Endpoints are based on the available Pipeline combinations.

Yes
Relative Path

The exact path where the file to be transferred exists on UDMG locally. The path is used to create a full path.

For more information, refer to Understanding Paths.

  • Format:
    • /
    • /[path]
    • /[path]/[subdir]
  • The subdirectory and file name should not be included here if they are added within the source parameter.
Yes
Virtual Path

The path or "Remote Server Path" where the file is to be transferred to on the external FTP(S) server. The Transfers Scheduled API destination parameter is appended to this path to create the full path.

The path must exist on the external remote FTP(S) server.

For more information, refer to Understanding Paths.

  • Format:
    • /
    • /[path]
    • /[path]/[subdir]
  • The subdirectory and file name should not be included here if they are added within the destination parameter.
Yes
Credentials NameThe client authentication Credentials used to authenticate to the external FTP(S) server.Must reference an already-created Credential of type Username and Password, Username and Key, or Username, Password, and Key. Yes
Universal EventWhile this field is currently in the form, it's not used in the remote transfer configuration.No

Editing a Pipeline​

To edit a Local Filesystem to Remote FTP(S) Server Pipeline, follow these steps:

  1. From the Sidebar, select Configuration > Pipelines.
  2. Click the Name of the Pipeline you want to edit.
  3. Click the Edit button above the Pipeline details.
  4. Edit details for the Pipeline.
    • The Source Endpoint and Destination Endpoint cannot be changed after creation.
  5. Click Update.
warning

Upon Pipeline update, UDMG checks for Endpoint Source + Endpoint Destination + Configuration + Virtual Path uniqueness.

Managing a Pipeline​

All Pipelines support the ability to view the complete Pipeline and linked Endpoint details.

Viewing Pipeline Details​

To view the details of a Local Filesystem to Remote FTP(S) Server Pipeline, follow these steps:

  1. From the Sidebar, select Configuration > Pipelines.
  2. Click the Name of the Pipeline you want to view.
  3. Click the Overview Tab or Details Tab to see additional Pipeline and Endpoint details.

Pipeline Metadata​

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

NameDescription
UUIDUniversally Unique Identifier of this Pipeline.
VersionVersion number of the configuration. Every change increases the number.
EnabledPipeline's Enabled status. If enabled, field is set to True.
CreatedDate and time this Pipeline was created.
UpdatedDate and time this Pipeline was last updated.

Enabling and Disabling Pipelines​

Pipelines can be Enabled or Disabled to control their active status and ability to participate in file transfers. The status is defaulted to Enabled and can be changed after creation. The Configuration Item's Disabled status does not impact whether it can be configured. Also, Disabled Endpoints can be added to a Pipeline.

  • Enabled (default): The Pipeline is active and allows file transfers.
  • Disabled: The Pipeline is inactive and does not allow file transfers.

To enable or disable a Pipeline, follow these steps:

  1. From the Sidebar, select Configuration > Pipelines.
  2. Click the Name of the Pipeline you want to enable or disable.
  3. Click the Enable or Disable button above the Pipeline details.
  4. If the Pipeline is Disabled, then the button displays Enabled. If the Pipeline is Enabled, then the button displays Disabled.
  5. Click Update.
info
Changes to a Pipeline's Enabled/Disabled status take effect the next time the Transfers Scheduled API is triggered. Disabling a Pipeline is a safe alternative to deleting it.

Deleting a Pipeline​

To delete a Local Filesystem to Remote FTP(S) Server Pipeline, follow these steps:

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

Monitoring a Pipeline​

To monitor and determine the status of a Pipeline, the Transfers page and Endpoints page must be monitored to track incoming Transfers and the Source and Destination Endpoints' individual statuses, respectively.

On the Transfers page, the following fields indicate the type of Remote Transfer.

  • Is Schedule: If Yes, then the Transfer was a Remote Transfer.
  • Is Send: If Yes, then the Remote Transfer was a push scenario.