Transport attribute definitions provide the metadata required at the transport layer. (In this context, “metadata” means the categories of information, not any actual values.) Once a transport attributes definition has been included in a B2B host, it is exposed to ePM so that specific values can be supplied for specific trading partner configurations.
The Sun SeeBeyond ⇒ eXchange ⇒ Transport Attribute Definitions foldercontains presupplied transport attribute definitions (TADs) and corresponding OTDs. See Figure 3–1. For more information, see Creating and Configuring TADs.
Different transport protocols require different types of attributes; for example, HTTP requires little more than a URL, but FTP requires a username, password, hostname, port, path, and file pattern, and possibly other attributes as well. For this reason, the metadata for HTTP-based and FTP-based TADs are quite different. When a TAD is referenced by a delivery channel, its attributes govern the appearance and behavior of ePM for users who supply values for that channel.
At run time, a TAD’s metadata is made available to the application through the two methods of its associated OTD: unmarshal parses an inbound stream into an internal data structure, and marshal serializes the internal data into a linear outbound stream.
All TADs define their metadata using the format shown in Table 3–1.
Table 3–1 Metadata for All Transport Attribute Definitions
Field Name |
Explanation |
---|---|
Name |
The (internal) parameter name. Used programmatically; never seen in ePM. |
Display |
The parameter label as seen by the ePM user. |
Type |
Data type. Used programmatically; never seen in ePM. |
Required |
Checkbox governing whether a value must be supplied in ePM. If yes, ePM displays an red asterisk to signal the user that this is a required value. |
Direction |
FromPartner, ToPartner, or Both. Used programmatically. |
Default |
The value supplied before the ePM user takes action, or takes no action. |
List of Values |
Items to display in a drop-down list for the ePM user to choose from |
Fixed |
(not used in any of presupplied TADs) |
Format String |
(not used in any of presupplied TADs) |
The Batch eWay uses the BatchFTP transport attributes definition to read from a remote file or write to a remote file. When designating a pattern of files to be read, the * (asterisk) is a wildcard meaning “zero or more characters.”
Table 3–2 lists the attributes of the BatchFTP TAD.
Table 3–2 Attributes for the BatchFTP Transport Attributes Definition
Name |
Display |
Type |
Req? |
Direction |
Default |
List |
---|---|---|---|---|---|---|
Append |
Append |
Boolean |
No |
Both | ||
HostName |
HostName |
String |
Yes |
Both | ||
ServerPort |
ServerPort |
Integer |
No |
Both | ||
CommandConnectionTimeout |
(same as Name) |
Integer |
No |
Both | ||
DataConnectionTimeout |
(same as Name) |
Integer |
No |
Both | ||
DirectoryListingStyle |
[...] |
String |
No |
Both | ||
ClientClassName |
String |
No |
Both | |||
ProviderClassName |
String |
No |
Both | |||
Mode |
String |
No |
Both | |||
UsePASV |
Boolean |
No |
Both | |||
UserName |
String |
No |
Both | |||
Password |
Password |
No |
Both | |||
UserPropertyFile |
String |
No |
Both | |||
TargetDirectoryName |
String |
Yes |
Both | |||
TargetDirectoryNameIsPattern |
Boolean |
No |
Both | |||
TargetFileName |
String |
Yes |
Both | |||
TargetFileNameIsPattern |
Boolean |
No |
Both | |||
MaxSequenceNumber |
Integer |
No |
Both | |||
StartingSequenceNumber |
Integer |
No |
Both | |||
PreDirectoryName |
String |
No |
Both | |||
PreDirectoryNameIsPattern |
Boolean |
No |
Both | |||
PreFileName |
String |
No |
Both | |||
PreFileNameIsPattern |
Boolean |
No |
Both | |||
PreTransferCommand |
String |
No |
Both | |||
PreTransferRawCommands |
String |
No |
Both | |||
PostDirectoryName |
String |
No |
Both | |||
PostDirectoryNameIsPattern |
Boolean |
No |
Both | |||
PostFileName |
String |
No |
Both | |||
PostFileNameIsPattern |
Boolean |
No |
Both | |||
PostTransferCommand |
String |
No |
Both | |||
PostTransferRawCommands |
String |
No |
Both | |||
ActionOnMalformedCommand |
String |
No |
Both | |||
IncludeOrderRecordInErrorRecord |
Boolean |
No |
Both | |||
IncludePayloadInErrorRecord |
Boolean |
No |
Both | |||
PublishStatusRecordOnError |
Boolean |
No |
Both | |||
PublishStatusRecordOnSuccess |
Boolean |
No |
Both | |||
SocksEnabled |
Boolean |
No |
Both | |||
SocksHostName |
String |
No |
Both | |||
SocksServerPort |
Integer |
No |
Both | |||
SocksVersion |
Integer |
No |
Both | |||
SocksUserName |
String |
No |
Both | |||
SocksPassword |
Password |
No |
Both | |||
SshTunnelingEnabled |
Boolean |
No |
Both | |||
SshListenHost |
[...] |
String |
No |
Both | ||
SshListenPort |
(same as Name) |
Integer |
No |
Both | ||
SshCommandLine |
(same as Name) |
String |
No |
Both | ||
SshUserName |
SshUserName |
String |
No |
Both | ||
SshPassword |
SshPassword |
Password |
No |
Both |
The Batch eWay uses the BatchLocalFile transport attributes definition to read from a local file or write to a local file. When designating a pattern of files to be read, the * (asterisk) is a wildcard meaning “zero or more characters.”
Table 3–3 lists the attributes of the BatchLocalFile TAD.
Table 3–3 Attributes for the BatchLocalFile Transport Attributes Definition
Name |
Display |
Type |
Req? |
Direction |
Default |
List |
---|---|---|---|---|---|---|
Append |
Append |
Boolean |
No |
Both | ||
TargetDirectoryName |
(same as Name) |
String |
Yes |
Both | ||
TargetDirectoryNameIsPattern |
(same as Name) |
Boolean |
No |
Both | ||
TargetFileName |
[...] |
String |
Yes |
Both | ||
TargetFileNameIsPattern |
Boolean |
No |
Both | |||
MaxSequenceNumber |
Integer |
No |
Both | |||
StartingSequenceNumber |
Integer |
No |
Both | |||
PreDirectoryName |
String |
No |
Both | |||
PreDirectoryNameIsPattern |
Boolean |
No |
Both | |||
PreFileName |
String |
No |
Both | |||
PreFileNameIsPattern |
Boolean |
No |
Both | |||
PreTransferCommand |
String |
No |
Both | |||
PostDirectoryName |
String |
No |
Both | |||
PostDirectoryNameIsPattern |
Boolean |
No |
Both | |||
PostFileName |
String |
No |
Both | |||
PostFileNameIsPattern |
Boolean |
No |
Both | |||
PostTransferCommand |
String |
No |
Both | |||
ResumeReadingEnabled |
Boolean |
No |
Both | |||
ActionOnMalformedCommand |
String |
No |
Both | |||
IncludeOrderRecordInErrorRecord |
Boolean |
No |
Both | |||
IncludePayloadInErrorRecord |
[...] |
Boolean |
No |
Both | ||
PublishStatusRecordOnError |
(same as Name) |
Boolean |
No |
Both | ||
PublishStatusRecordOnSuccess |
(same as Name) |
Boolean |
No |
Both |
The File eWay uses the FILE transport attributes definition to read from a file or write to a file. When designating a pattern of files to be read, the * (asterisk) is a wildcard meaning “zero or more characters.”
Table 3–4 lists the attributes of the FILE TAD.
Table 3–4 Attributes for the FILE Transport Attributes Definition
Name |
Display |
Type |
Req? |
Direction |
Default |
List |
---|---|---|---|---|---|---|
FilePattern |
FilePattern |
String |
Yes |
Both | ||
Directory |
Directory |
String |
Yes |
Both |
For File Transfer Protocol, the BatchFTP eWay uses the FTP transport attributes definition to read from a file or write to a file in a remote location. When designating a pattern of files to be read, the * (asterisk) is a wildcard meaning “zero or more characters.”
Table 3–5 lists the attributes of the FTP TAD.
Table 3–5 Attributes for the FTP Transport Attributes Definition
Name |
Display |
Type |
Req? |
Direction |
Default |
List |
---|---|---|---|---|---|---|
FilePattern |
FilePattern |
String |
Yes |
Both | ||
Directory |
Directory |
String |
Yes |
Both | ||
UserName |
UserName |
String |
Yes |
Both | ||
Password |
Password |
Password |
Yes |
Both | ||
HostName |
HostName |
String |
Yes |
Both | ||
PortNumber |
PortNumber |
Integer |
No |
Both | ||
SocksEnabled |
SocksEnabled |
Boolean |
No |
Both |
false | |
SocksHostName |
SocksHostName |
String |
No |
Both | ||
SocksUserName |
SocksUserName |
String |
No |
Both | ||
SocksPassword |
SocksPassword |
Password |
No |
Both | ||
SocksServerPort |
SocksServerPort |
String |
No |
Both |
For Hypertext Transfer Protocol, the HTTPS eWay can use the URL attribute in the HTTP TAD to access Web pages. The HTTP TAD has the corresponding OTD: HTTPOTD_HTTP.
For Hypertext Transfer Protocol over SSL (Secure Sockets Layer), the HTTPS eWay uses the HTTPS transport attributes definition to access secure Web pages.
Table 3–6 lists the attributes of the HTTPS TAD.
Table 3–6 Attributes for the HTTPS Transport Attributes Definition
Name |
Display |
Type |
Req? |
Direction |
Default |
List |
---|---|---|---|---|---|---|
ClientCertAlias |
ClientCertAlias |
String |
Yes |
Both | ||
UserName |
UserName |
String |
Yes |
Both | ||
Password |
Password |
Password |
Yes |
Both |
To use HTTPS, two environment components require non-default settings: in the Integration Server, the Web server configuration must have its “Enable SSL” parameter set to “True”, and in the HTTPS external, the SSL configuration must supply a value for its “TrustStore” parameter.
The JMS transport attributes definition is used to transport data into and out of JMS topics and queues.
For Simple Mail Transfer Protocol, the email eWay uses the SMTP transport protocol to send and receive email.
Table 3–7 lists the attributes of the SMTP TAD.
Table 3–7 Attributes for the SMTP Transport Attributes Definition
Name |
Display |
Type |
Req? |
Direction |
Default |
List |
---|---|---|---|---|---|---|
SenderAddress |
SenderAddress |
String |
Yes |
ToPartner | ||
Host |
Host |
String |
Yes |
ToPartner | ||
PortNumber |
PortNumber |
String |
Yes |
ToPartner | ||
UserName |
UserName |
String |
No |
Both | ||
Password |
Password |
Password |
No |
Both |