Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleInfo

Refer to Universal Controller documentation: Creating a Universal Event Template.

The following table shows an example of a Universal Event Template for file transfer. 

...

Info
titleInfo

Refer to Universal Controller documentation: Creating a Universal Event Template.

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

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
Any extra attributes will be allowed and passed through as variables.

Attributes

Add the following attributes:

NameLabelType
truefilenameactual name of the file on the diskText
fullpathoriginal path of the file before the transferText
truefullpathactual path of the file on the diskText
datedate (in format AAAAMMJJ) when the transfer was executedText
sizefilesizeFloat
requestedhostidentifier of the partner who received the transfer requestText
requesterhostidentifier of the partner who requested the transferText
localhostlocal partnerText
filenameoriginal name of the file before the transferText
remotehostremote partnerText
rulerule used by the transferText
hourtime (in format HHMMSS) at the time of the execution of the transferText
transferidtransfer IDText
errormsgerror messageText
errorcodeerror codeText


The template can also be created with the Universal Template Web Services.

Expand
titleWeb Service Example


Code Block
languagebash
titleCurl 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 it is required to have an event on Universal Controller.

...

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 Error Tasks. It is enough to have only this task.

...

Info
titleInfo

Refer to Creating a Universal Monitor Task

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.

...

Info
titleInfo

Refer to Creating a Universal Monitor Trigger

Create a Univerval Universal Monitor Trigger and select the Universal Monitor Task that was created to filter the events to be caught.

...