...
Each time a file transfer action occurs on the UDMG server a Universal Event can be generated. This event can be used to trigger a Universal Monitor Task for the processing of the file or for further actions in relation to this transfer.
...
The following table shows an example of a Universal Event Template for file transfer.
...
The template can also be created with the Universal Template Web Services.
Expand |
---|
|
Code Block |
---|
language | bash |
---|
title | Curl Request |
---|
| curl -L -X POST 'http://host_name/uc/resources/universaltemplate' \
-H 'Content-Type: application/json' -H 'Accept: application/json' \
--data-raw '{
"attributesPolicy": "Include Attributes",
"description": "Event for when a file is transferred by UDMG server",
"label": "UAC User Event: UDMG transfer",
"name": "b2bmft",
"ttl": 60000,
"attributes": [
{
"label": "actual name of the file on the disk",
"name": "truefilename",
"type": "Text"
},
{
"label": "original path of the file before the transfer",
"name": "fullpath",
"type": "Text"
},
{
"label": "actual path of the file on the disk",
"name": "truefullpath",
"type": "Text"
},
{
"label": "date (in format AAAAMMJJ) when the transfer was executed",
"name": "date",
"type": "Text"
},
{
"label": "filesize",
"name": "size",
"type": "Float"
},
{
"label": "identifier of the partner who received the transfer request",
"name": "requestedhost",
"type": "Text"
},
{
"label": "identifier of the partner who requested the transfer",
"name": "requesterhost",
"type": "Text"
},
{
"label": "local partner",
"name": "localhost",
"type": "Text"
},
{
"label": "original name of the file before the transfer",
"name": "filename",
"type": "Text"
},
{
"label": "remote partner",
"name": "remotehost",
"type": "Text"
},
{
"label": "rule used by the transfer",
"name": "rule",
"type": "Text"
},
{
"label": "time (in format HHMMSS) at the time of the execution of the transfer",
"name": "hour",
"type": "Text"
},
{
"label": "transfer ID",
"name": "transferid",
"type": "Text"
}
]
}
' |
|
...
The following table shows an example of a Universal Event Template for file transfer error.
...
The template can also be created with the Universal Template Web Services.
Expand |
---|
|
Code Block |
---|
language | bash |
---|
title | Curl Request |
---|
| curl -L -X POST 'http://host_name/uc/resources/universaltemplate' \
-H 'Content-Type: application/json' -H 'Accept: application/json' \
--data-raw '{
"attributesPolicy": "Include Attributes",
"description": "Event for error with file transfer by UDMG server",
"label": "UAC User Event: UDMG transfer error",
"name": "b2bmft_error",
"ttl": 6000,
"attributes": [
{
"label": "actual name of the file on the disk",
"name": "truefilename",
"type": "Text"
},
{
"label": "original path of the file before the transfer",
"name": "fullpath",
"type": "Text"
},
{
"label": "actual path of the file on the disk",
"name": "truefullpath",
"type": "Text"
},
{
"label": "date (in format AAAAMMJJ) when the transfer was executed",
"name": "date",
"type": "Text"
},
{
"label": "filesize",
"name": "size",
"type": "Float"
},
{
"label": "identifier of the partner who received the transfer request",
"name": "requestedhost",
"type": "Text"
},
{
"label": "identifier of the partner who requested the transfer",
"name": "requesterhost",
"type": "Text"
},
{
"label": "local partner",
"name": "localhost",
"type": "Text"
},
{
"label": "original name of the file before the transfer",
"name": "filename",
"type": "Text"
},
{
"label": "remote partner",
"name": "remotehost",
"type": "Text"
},
{
"label": "rule used by the transfer",
"name": "rule",
"type": "Text"
},
{
"label": "time (in format HHMMSS) at the time of the execution of the transfer",
"name": "hour",
"type": "Text"
},
{
"label": "transfer ID",
"name": "transferid",
"type": "Text"
},
{
"label": "error message",
"name": "errormsg",
"type": "Text"
},
{
"label": "error code",
"name": "errorcode",
"type": "Text"
}
]
}
' |
|
...
The task is configured for every transfer rule for which is is required to have an event on Universal Controller.
TYhe The interface with the Universal Controller is through the Universal Event Publishing Web Service.
The table below show the list of parameters that are accepted by the PUBLISHEVENT task. Except for the path
, they are passed as attributes to the Universal Event.
Parameter | Description |
---|
path | Path to the Universal Controller API configuration file. Note |
---|
| This parameter is not passed as an event attribute. |
Warning |
---|
| For Windows path, the '\' character must be escaped as '\\'. For example, instead of "C:\DATA\UDMG" , input "C:\\DATA\\UDMG" |
|
rule | The rule used by the transfer |
date | The date (in format AAAAMMJJ) when the transfer task was executed |
hour | The time (in format HHMMSS) at the time of the execution of the transfer task |
filesize | File size (as string) |
inpath | The path to the receiving folder for the current transfer. This path depends on the configuration (folder for sending the rule, the server or the Gateway depending on the case) |
outpath
| The path to the receiving folder for the current transfer. This path depends on the configuration (folder for sending the rule, the server or the Gateway depending on the case) |
trueFullPath | The actual path of the file on the disk |
trueFilename | The actual name of the file on the disk |
fullPath | The original path of the file before the transfer |
filename | The original name of the file before the transfer |
remoteHost | The identifier of the remote partner |
localHost | The identifier of the local partner |
transferID | The transfer ID |
requesterHost | The identifier of the partner who requested the transfer |
requestedHost | The identifier of the partner who received the transfer request |
size | File size (as number) |
errorcode | Error Code (only for error situation) |
errormsg | Error Message (only for error situation) |
...
Configuration of Universal Monitor Task for UDMG File Transfer Event
Create a Univerval Monitor task and select the Universal Event Template that was created for UDMG File Transfer.
...
Configuration of Universal Monitor Trigger for UDMG File Transfer Event
Create a Univerval Monitor Trigger and select the Universal Monitor Task that was created to filter the events to be caught.
...