Folder Management
- Olivier Michaut
Overview
During a transfer, the user only enters the end of the file path to be transferred. The beginning of this path is calculated by udmg-server according to the following configurations:
- udmg-server settings, common to all transfers
- local server, common to all transfers to/from this server (not valid for client transfers)
- transfer rule, common to all transfers using the same rule
More specific paths have priority over more global paths.
Note
A rule's local, remote and temporary paths must not be confused with its (virtual) path. The path is only used to identify the rule and is not used to calculate file paths.
Let's take the example of an incoming transfer where the UDMG Server acts as a server. The file to be transferred is file.txt.
Depending on the values of the various configurations, the destination path of the file will change as follows:
udmg-server root folder | udmg-server “in” folder | Local Server root folder | Local Server receive folder | Transfer Rule local folder | Final file path |
|---|---|---|---|---|---|
/root | in | /root/in/file.txt | |||
/root | /in | /in/file.txt | |||
/root | /in | server | /root/server/file.txt | ||
/root | /in | /server | /server/file.txt | ||
/root | /in | /server | serv_recv | /server/serv_in/file.txt | |
/root | /in | /server | /serv_recv | /serv_in/file.txt | |
/root | /in | /server | /serv_recv | rule_local | /server/rule_local/file.txt |
Outgoing transfers work in a similar way, but replace the UDMG Server's in folder with its out folder; and replace the Local Server's receive folder with its send folder.
Client transfers also work in a similar way, but without the server-specific folders.
Detailed explanations
UDMG Server folders
Every instance of UDMG Server has a root folder (called GatewayHome) which the user must enter in the configuration file. By default, if the user has not specified a root, the current folder is used. By default, all non-absolute paths will be relative to this root.
It is also in the configuration file that our 3 folders mentioned above are defined, respectively with the options: the "in" folder (DefaultInDir), the "out" folder (DefaultOutDir), and the temporary folder (DefaultTmpDir). During a transfer, if no more specific path is specified, these folders will be used locally as the source or destination of the file.
By default, they are assigned the values "in", "out" and "work" respectively. These paths are relative to the root mentioned above. It is also possible to enter an absolute path if the user does not wish one or more of the folders to be located under the root.
Server folders
When creating a local server, you can specify a server root (root attribute), as well as sub-folders for receive, send and temporary receive (tmpReceive).
The root can be an absolute or relative path. In the latter case, the path is relative to the UDMG Server root. Similarly, sub-folders can be absolute or relative, in which case they will be relative to the server root.
Being attached to a local server, these folders are only used for transfers where the UDMG Server acts as a server. If server folders are defined, they override the UDMG Server's global folders when calculating the file path.
Rule folders
When a transfer rule is created, specific folders can be assigned to it. These folders include: a local folder on the UDMG Server, a remote folder on the partner(s), and a temporary local folder (tmpLocal).
All files transferred with this rule will therefore use these folders. For send rules, files will always be retrieved from the local folder, then dropped into the remote folder. Conversely, in the case of receive rules, files will always be retrieved from the remote folder, then dropped into the local temporary folder, before being moved to the receive folder once the transfer is complete.
These folders can be absolute or relative paths. In the latter case, if the UDMG Server is acting as a transfer client, the path is relative to the root. On the other hand, if the UDMG Server is the transfer server, then any relative path is considered to be relative to the local server's root, if it has one, or to the gateway's root if it doesn't have one.