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 file processing or further actions concerning this transfer.
The event can be published before, after, or in case of an error for a file transfer.
Configure events for successful and error conditions. |
Refer to Universal Controller documentation: Creating a Universal Event Template. |
The following table shows an example of a Universal Event Template for file transfer.
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 Controller.
Field Name | Sample Value and Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | b2bmft | ||||||||||||||||||||||||||||||||||||||||||||||||
Label | UAC User Event: UDMG transfer | ||||||||||||||||||||||||||||||||||||||||||||||||
Description | Event for when a file is transferred by UDMG Server | ||||||||||||||||||||||||||||||||||||||||||||||||
Time To Live | 60000 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 | ||||||||||||||||||||||||||||||||||||||||||||||||
Attributes | Add the following attributes:
|
The template can also be created with the Universal Event Template Web Services.
|
The Universal Event Template Details are shown below.
Refer to Universal Controller documentation: Creating a Universal Event Template. |
The following table shows an example of a Universal Event Template for file transfer errors.
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 Controller.
Field Name | Sample Value and Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | b2bmft_error | ||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||
Attributes | Add the following attributes:
|
The template can also be created with the Universal Event Template Web Services.
|
The Universal Event Template Details are shown below.
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 UDMG-Client.
The task is configured for every transfer rule for which it 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 shows the list of parameters that are accepted by the PUBLISHEVENT task. Except for the path
, they are passed as attributes to the Universal Event.
For the other parameter, the related placeholder variable must be used, see the section below.
Parameter | Description | ||
---|---|---|---|
path | Path to the Universal Controller API configuration file.
| ||
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 udmg-server instance depending on the case). | ||
| 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 udmg-server instance 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 situations). | ||
errormsg | Error Message (only for error situations). |
Placeholder | Description |
---|---|
#TRUEFULLPATH# | The actual path of the file on disk may differ from the original path if the file has been renamed or moved by a UDMG task. |
#TRUEFILENAME# | The actual name of the file on disk. It may differ from the original path if the file has been renamed or moved by a UDMG task. |
#ORIGINALFULLPATH# | The original path of the file before transfer. |
#ORIGINALFILENAME# | The original name of the file before transfer. |
#FILESIZE# | File size (value in bytes). |
#HOMEPATH# | The root folder of the udmg-server . This path is always absolute. |
#INPATH# | The default receiving folder is defined in the configuration file. This path is always absolute. |
#OUTPATH# | The default upload folder is defined in the configuration file. This path is always absolute. |
#WORKPATH# | The default temporary receiving folder is defined in the configuration file. This path is always absolute. |
#RULE# | The rule used by the transfer. |
#DATE# | The date (in format YYYYMMDD) when the transfer was executed. |
#HOUR# | The time (in format HHMMSS) when the transfer was executed. |
#REMOTEHOST# | The remote partner identifier. The Shared Account login for a server transfer, and the Remote Partner name for a client transfer. |
#LOCALHOST# | The local partner identifier. The Local Server name for a server transfer, the Remote Account login for a client transfer. |
#TRANSFERID# | The transfer ID. |
#REQUESTERHOST# | The partner who requested the transfer. The Shared Account login is for a server transfer, and the Remote Account login for a client transfer. |
#REQUESTEDHOST# | The partner who received the transfer request. The Local Server name is for a server transfer, and the Remote Partner name for a client transfer. |
#FULLTRANSFERID# | An "extended" identifier for transfer (in the form TRANSFERID_REQUESTERHOST_REQUESTEDHOST). |
#ERRORMSG# | Error message (in error handling). |
#ERRORCODE# | Error code (in error handling). |
In addition to these standard placeholders, it is also possible to reference the transfer information key in the definition of a task. To do this, use is the following:
#TI_<key_name>#
where <key_name>is replaced with the name of the desired key.
At runtime, it will then be substituted by the value associated with the key. For instance #TI_udmg_xfer_log#
to get the path of the UDMG transfer log file.
The configuration file is set at the task level and specifies that the Universal Event Template and the Universal Control URL are used for publishing the event.
Being a parameter of the PUBLISHEVENT task, it can be different for each transfer rule and each use of the task. This allows the usage of different Universal Event Templates for successful (for example b2bmft) and failed (for example b2bmft_error) file transfers.
uac_rest
'.Option Name | Description | |
| This specifies where the Event will be published. It is the URI of the Publish Universal Event API on the target Universal Controller | |
| Universal Event Template Name. | |
| 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. |
Usage | INI File | ||
---|---|---|---|
Rule Processing Task for Successful Transfer |
| ||
Rule Processing Task for Transfer in Error |
|
To send an event after the completion of the file transfer, the rule that is associated with the transfer must have the PUBLISHEVENT task in the list of Post-Tasks. It is enough to have only this task.
The configuration for Pre-Task, Post-Task, and Error-Task is under the Rule tab. |
|
To send an event after an error occurred during the file transfer, the rule that is associated with the transfer must have the PUBLISHEVENT task in the list of Error Tasks. It is enough to have only this task.
The configuration for Pre-Task, Post-Task, and Error-Task is under the Rule tab. |
|
Refer to Creating a Universal Monitor Task. |
Create a Universal Monitor task and select the Universal Event Template 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 inferred from the transfer rule name, provided that a consistent naming convention is used.
Refer to Creating a Universal Monitor Trigger. |
Create a Universal Monitor Trigger and select the Universal Monitor Task created to filter the events to be caught.
Select one or more tasks to be triggered for each event. The event attributes are passed as variables to the tasks, which then retrieve the details of the file transfer.
The variable name is formed using ops_trigger + universal template name + event attribute name. For example, ops_trigger_b2bmft_filesize
for the filesize attribute.
Example of the variables for a Task inside a Workflow that was triggered by a Universal Trigger: