Metadata file

The metadata file is an XML file that contains a Transfer element. The elements in the following table must be included in the Transfer element unless noted as optional:

Element Description Valid values Notes
SourceFileLocation Path to the transferred file Full path name or path relative to RemoteSharePath See Location of the transferred file.
RemoteSharePath Path to the shared directory on the remote system Full path name Optional. SecureTransport uses this to determine the location of the transferred file. See Location of the transferred file.
LocalSharePath Path to the shared directory on the SecureTransport system Full path name

Optional.

Optional for transfers to SecureTransport. SecureTransport uses this to determine the location of the transferred file. See Location of the transferred file.

CycleID Processing cycle identifier for the file transfer Any valid cycle ID SecureTransport uses this cycle ID in events reported to Axway Sentinel.
Protocol Name of a file services interface protocol Any protocol defined in the file services interface protocol registry SecureTransport displays the corresponding display name in Protocol column of the File Tracking page and in events it sends to Axway Sentinel.
Mode File transfer mode A for ASCII or I for binary  
Recipients Container for Recipient elements N/A Optional. Contains any number of Recipient elements.
Recipient A recipient for the file N/A Optional. Contains a Name element and, optionally, a Path element
Name Login name of a SecureTransport account to receive the file Any existing account login name  
Path Path to the directory where SecureTransport copies the file, relative to the account home folder Path to any directory in the home folder of the named account Optional. The default is the home folder of the account.
Parameters Container for Parameter elements N/A Optional. Contains any number of Parameter elements.
Parameter A parameter N/A Optional. Contains a Key element and, optionally, a Value element.
Key Key ID for the parameter Any string  
Value Value of the parameter Any string Optional.

The following is an example of a metadata file:

<?xml version="1.0" encoding="UTF-8"?>
<Transfer>
   <SourceFileLocation>/opt/shared/incoming/report-20110704
      </SourceFileLocation>
   <CycleId>2162164</CycleId>
   <Protocol>T3Direct</Protocol>
   <Mode>I</Mode>
   <Recipients>
      <Recipient>
         <Name>acctng</Name>
         <Path>/incoming/reports</Path>
      </Recipient>
         <Recipient>
         <Name>audit</Name>
      <Path>/incoming/check</Path>
      </Recipient>
   </Recipients>
   <Parameters>
      <Parameter>
         <Key>status</Key>
         <Value>complete</Value>
      </Parameter>
   </Parameters>
</Transfer>

Related topic:

Related Links