Module for EDIINT Version 8.2 SP1.November 2013 | Installing and Using EDIINT Module | Before You Can Transport Documents Using EDIINT | Configuring Your System to Support EDIINT AS3 | Creating Trading Partner Agreements (TPAs) for AS3 Support | Creating a new TPA
 
Creating a new TPA
*To create a new TPA
1. In My webMethods, go to Administration > Integration > B2B > Trading Partner Agreements.
2. On the Agreements screen, create either a new TPA or a duplicate TPA. When you duplicate a TPA, you can update any or all of the fields. Also, you can use the duplicate TPA option to create a template TPA.
*To create a new TPA (the TPA fields are empty), select Add TPA.
Trading Networks displays the Trading Partner Agreement Details screen.
*To create a duplicate TPA (the TPA fields are filled with values from an existing TPA), click the row containing the name of the TPA that you want to duplicate and then click .
Trading Networks displays the Agreement Details screen.
3. On the Trading Partner Agreement Details screen, complete the following fields for the TPA you want to create:
Note:
The Sender, Receiver, and Agreement ID fields must be unique for each TPA. After you create a TPA, you cannot change or update these fields of the TPA.
For this TPA field...
Specify...
Agreement ID
The Agreement ID EDIINTAS3, which indicates that the type of agreement between the two partners is an AS3 agreement using EDIINT.
Note:
You will not be able to continue creating a TPA unless you specify the Agreement ID.
Sender
The name of the trading partner that has the sender role in the transaction the TPA will govern. Type in the name of the partner or click Edit to select the sender from the Select Partner dialog. This list includes your own profile (Enterprise).
For EDI, to create a template that you will duplicate to create other TPAs, you can use the default value of Unknown.
Receiver
The name of the trading partner that has the receiver role in the transaction the TPA will govern. Type the name of the receiver or click Edit to select the receiver from the Select Partner dialog. This list includes your own profile (Enterprise).
For EDI, to create a template that you will duplicate to create other TPAs, you can use the default value of Unknown.
Description
Optional. A description for the TPA. You can use up to 1024 characters of any type.
Data Status
Whether you want to be able to modify the values of the TPA data of the IS document type. The data status is only applicable when the agreement status is Agreed.
Initialization Service
The wm.EDIINT.TPA:initService service. This service populates the inputs to the variables in the IS document type wm.EDIINT.TPA:EDIINTAS3 with default values.
Type the name of the initialization service located on the server or click Edit to browse the services and select the one you want to use.
IS Document Type
The IS document type wm.EDIINT.TPA:EDIINTAS3. This IS document type defines the application-specific TPA data. The TPA data is used to govern the exchange of documents between the two partners.
Alternatively, click Find IS Document Type to browse the IS document types and select wm.EDIINT.TPA:EDIINTAS3. Trading Networks displays the data tree input values of the selected IS document type in the bottom panel of the Agreement Details screen.
For more information about creating TPAs, see the webMethods Trading Networks Administrator’s Guide for your release.
4. Click the Set Inputs icon and provide values for the following upload input parameters for the document type wm.EDIINT.TPA:EDIINTAS3:
For this upload parameter...
Specify...
AS3FTPServerLocation
Whether to upload/download EDIINT AS3 messages to a remote or local FTP server:
*remote—Upload/download EDIINT AS3 messages to/from the remote FTP server in the FTPUpload and FTPDownload fields.
*local—Upload/download EDIINT AS3 messages to/from the local FTP server. No other TPA fields will be used.
uploadService
The wm.EDIINT.delivery.defaultFTPUpload service, which uploads AS3 files.
serverhost
The name or IP address of the FTP server.
serverport
The port number on which the FTP server listens for requests. The default is 21.
dataport
Optional. The listener port number of the data transfer channel, for example, 3345.
username
The FTP user on the remote FTP server.
password
The password for the user specified in username.
account
Optional. The user name for an account on the FTP server. Specify a value if your FTP host requires account information. The account is defined in the FTP protocol to further identify the user and password specified in username and password.
transfertype
The type of the FTP data transfer mode:
*active—Active FTP data transfer mode. This is the default.
*passive—Passive FTP data transfer mode.
encoding
Optional. The default character set for encoding data transferred during this session. Specify an IANA-registered character set, for example, ISO-8859-1. If you do not set encoding, the default JVM encoding is used.
timeout
Optional. The time (measured in seconds) to wait for a response from the FTP server before timing out and terminating the request. The default is to wait forever.
secureFTP
The type of the remote FTP server to connect to.
securedata
Whether to protect the FTP data channel:
*True—Protect the FTP data channel.
*False—Do not protect the FTP data channel.
auth
The authentication/security mechanism:
*SSL
*TLS
*TLS-P
dirpath
Optional. The directory path to which EDIINT AS3 messages are uploaded. If you do not specify a directory path, the current directory will be used.
fileExtension
Optional. The file extension to be assigned to the uploaded EDIINT AS3 message file, for example, msg.
EDIINT AS3 message file names are generated using the following naming convention:
MMddhhmmSSss
where MM is month, dd is day, hh is hour, mm is minutes, and SSss is seconds. For example, a generated file name with the extension msg might be 122012002222.msg.
renameTo
Optional. The new file extension. After uploading the EDIINT AS3 message file, move it to a specified directory, and optionally rename the file extension.
For example, if your FTP put command places the AS3 file in the tmp directory and you want to move it to the outbox directory after uploading it, specify this command in the renameTo field:
/outbox/*
The wildcard character * is a placeholder for the file name.
If you specified a file extension in the fileExtension field (for example, msg), you would specify this command in the renameTo field:
/outbox/*.msg
Optionally, you can rename the file extension in this field as well.
MDNDirpath
Optional. The directory to which MDNs are uploaded.
MDNFileExtension
Optional. The file extension to be assigned to the uploaded MDN file, for example, mdn.
MDN file names are generated using the following naming convention:
MMddhhmmSSss
where MM is month, dd is day, hh is hour, mm is minutes, and SSss is seconds. For example, a generated file name with the extension mdn might be 122012002222.mdn.
MDNRenameTo
Optional. The new file extension. After uploading the MDN files, move it to a specified directory, and optionally rename its file extension.
For example, if your FTP put command places the MDN file in the tmp directory and you want to move it to the outbox directory after uploading it, specify this command in the renameTo field:
/outbox/*
The wildcard character * is a placeholder for the file name.
If you specified a file extension in the fileExtension field (for example, mdn), you would specify this command in the renameTo field:
/outbox/*.mdn
Optionally, you can rename the file extension in this field as well.
storeUnique
Optional. A unique file name that EDIINT assigns after the file is uploaded.
transfermode
The type of the FTP file transfer mode:
*binary (required for AS3)
*ascii
5. Scroll down and provide values for the following download input parameters for wm.EDIINT.TPA:EDIINTAS3:
For this download parameter...
Specify...
downloadService
The wm.EDIINT.delivery.defaultFTPDownloadservice, which downloads AS3 files.
serverhost
The name or IP address of the FTP server.
serverport
The port number of the FTP server. The default is 21.
dataport
Optional. The listener port number of the data transfer channel, for example, 3345.
username
The FTP user on the remote FTP server.
password
The password for the user specified in username.
account
Optional. The user name for an account on the FTP server. Specify a value if your FTP host requires account information. The account is defined in the FTP protocol to further identify the user and password specified in username and password.
transfertype
The type of the FTP data transfer mode:
*active—Active FTP data transfer mode. This is the default.
*passive—Passive FTP data transfer mode.
encoding
Optional. The default character set for encoding data transferred during this session. Specify an IANA-registered character set, for example, ISO-8859-1. If you do not set encoding, the default JVM encoding is used.
timeout
Optional. The time (measured in seconds) to wait for a response from the FTP server before timing out and terminating the request. The default is to wait forever.
secureFTP
The type of the remote FTP server to connect to.
securedata
Whether to protect the FTP data channel:
*True—Protect the FTP data channel.
*False—Do not protect the FTP data channel.
auth
The authentication/security mechanism:
*SSL
*TLS
*TLS-P
dirpath
Optional. The directory path to which EDIINT AS3 messages are downloaded. If you do not specify a directory path, the current directory will be used.
filenamepattern
Optional. The EDIINT AS3 message file pattern, for example, *.msg.
MDNDirpath
Optional. The directory to which MDNs are downloaded. You can specify either the path relative to dirpath or the absolute path.
MDNFilenamepattern
Optional. The MDN message file pattern, for example, *.mdn.
deleteFile
Whether the file is to be deleted after downloading it.
transfermode
The type of the FTP file transfer mode:
*binary (required for AS3)
*ascii
6. Click OK to create the TPA.