...
Each time a file transfer action occurs on the UDMG server a 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 Event Template Web Services.
| Expand |
|---|
|
| Code Block |
|---|
| language | bash |
|---|
| title | Curl Request |
|---|
| curl -L -X POST 'http://host_name/uc/resources/universaltemplateuniversaleventtemplate' \
-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 attributes are populated by UDMG when the Universal Event is published on the Universal Controller. It is possible to create different templates that can be triggered for different transfer scenarios on UDMG. Each type of event can then be monitored and intercepted differently on the Universal controllerController.
Field Name | Sample Value and Description |
|---|
Name | |
Label | UAC User Event: UDMG transfer error |
Description | Event for error with file transfer by UDMG server |
| Time To Live | 6000 Default value for the length of time, in minutes, that the Universal Event data is valid. This value can be unspecified (null). The Time To Live value can be overridden in the published event. The value can be tuned depending on business or operational requirements. |
| Unmapped Attributes Policy | Include Attributes
Any extra attributes will be allowed and passed through as variables. |
| Attributes | Add the following attributes: | Name | Label | Type |
|---|
truefilename | actual name of the file on the disk | Text | fullpath | original path of the file before the transfer | Text | truefullpath | actual path of the file on the disk | Text | date | date (in format AAAAMMJJ) when the transfer was executed | Text | size | filesize | Float | requestedhost | identifier of the partner who received the transfer request | Text | requesterhost | identifier of the partner who requested the transfer | Text | localhost | local partner | Text | filename | original name of the file before the transfer | Text | remotehost | remote partner | Text | rule | rule used by the transfer | Text | hour | time (in format HHMMSS) at the time of the execution of the transfer | Text | transferid | transfer ID | Text | errormsg | error message | Text | errorcode | error code | Text |
|
The template can also be created with the Universal Event Template Web Services.
| Expand |
|---|
|
| Code Block |
|---|
| language | bash |
|---|
| title | Curl Request |
|---|
| curl -L -X POST 'http://host_name/uc/resources/universaltemplateuniversaleventtemplate' \
-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 publishing of Universal Event is enabled with the UDMG processing task PUBLISHEVENT, which is an addition to the standard tasks that are provided by the Waarp GatewayUDMG-Client.
The task is configured for every transfer rule for which it is is required to have an event on Universal Controller.
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.
...
Option Name | Description |
EventUrl
| Specify the URL for the Target Universal Controller. This specifies where the Event will be published. |
EventName | Universal Event Template Name |
EventTTL | Universal Event Template Time To Live in minutes (optional) |
UACEventUsername | Name of the user to access the Universal Controller REST API
|
UACEventPassword | Password to access the Universal Controller REST API |
...
To send an event after an error occured occurred during a the file transfer, the rule that is associated with the transfer requires to have the PUBLISHEVENT task in the list of Rrror Error Tasks. It is enough to have only this task.
...
Configuration of Universal Monitor Task for UDMG File Transfer Event
Create a Univerval Universal Monitor task and select the Universal Event Template that was created for UDMG File Transfer.
Additional criteria can be selected to filter the event, by using the event attributes (which contain the file transfer metadata from UDMG). For example the file transfer direction can be infered inferred from the transfer rule name, provided that a consistent naming convention is in place.
...
Configuration of Universal Monitor Trigger for UDMG File Transfer Event
Create a Univerval Universal Monitor Trigger and select the Universal Monitor Task that was created to filter the events to be caught.
...
