IP*Works! EDI AS3 EDI Component : AS3 EDI OCX, AS3 EDI .NET Component, AS3 EDI Class, AS3 EDI Bean, AS3 EDI Object

Available in: EDI/AS2

AS3Receiver Component [IP*Works! EDI V8]

Properties Methods Events Configuration Settings

The AS3Receiver component is used to process AS3 messages and generate receipts.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The AS3Receiver component allows you to receive AS3 messages over FTP, as specified in [AS3] and RFC 3335. The component can act as a FTP client, decrypt and verify incoming messages, and generate receipts including Message Disposition Notifications (MDNs). The component is designed to interoperate easily with a standard FTP server.

BASIC OPERATION

You should first log in to the FTP server by invoking Logon. If you need to search the FTP server for requests you may set RemotePath, invoke ListDirectory, etc. When you find the desired files you may then download them invoking ReadRequest. Alternatively, if you acquire the AS3 data by other means you may simply set Request.

ReadRequest (or ParseHeaders) will determine information such as AS3From and AS3To, which will allow you to set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in [AS3]. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned over the same FTP connection by invoking SendResponse. If it is necessary to create a new connection or send receipts to a different server you may Logoff and Logon at will.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data, and will also write the received EDI files to disk.

EXAMPLE

AS3Receiver1.User = "myusername" AS3Receiver1.Password = "mypassword" AS3Receiver1.RemoteHost = "ftp.mytradingpartner.com" AS3Receiver1.Logon() // You may need to search the server for received files at this point AS3Receiver1.ReadRequest("1053-ji094986.as3") // At this point, you should check the values of AS2From and AS2To. AS3Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS3Receiver1.SignerCert = (...); AS3Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS3Receiver1.ProcessRequest(); // It will probably be necessary to change the RemotePath or even logon // to a different server here. AS3Receiver1.SendResponse("1053-ji094986-mdn.as3");
Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN. See the property and method list for details.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


AS3From	The identity of the sending system.
AS3To	The identity of the receiving system.
AS3VersionIncoming	The version of AS3 being used.
AS3VersionOutgoing	The version of AS3 being used.
Attachments	Collection of files attached to the current message.
Certificate	The decryption and receipt signing certificate.
CompressionFormat	The compression format used on the incoming message.
Connected	Shows whether the component is connected.
EDIData	The EDI data sent in Request .
Firewall	A set of properties related to firewall access.
FTPCommand	An FTP command to be sent directly to the FTP server.
FTPLastReply	The last reply from the FTP server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LogDirectory	The path to a directory for logging.
LogFile	The log file written.
MDNReceipt	The MDN-based receipt generated by the component.
MDNTo	The URL for the Message Disposition Notification (MDN).
MessageId	The message ID of the incoming message.
Passive	Controls whether to direct the server into passive mode. Recommended if behind a firewall.
Password	The password to login with.
RemoteHost	The domain name or IP address of the FTP server.
RemotePath	The current path in the FTP server.
RemotePort	The port for the FTP service (default is 21).
Request	The AS3 request to process.
RequestHeaders	The headers in the AS3 request.
RequestHeadersString	The headers in the AS3 request.
ScanResult	The result of invoking ParseRequest .
SignerCert	Your trading partner's certificate.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during ssl negotiation.
SSLServerCert	The server certificate for the last established connection.
SSLStartMode	Determines how the component starts the SSL negotiation. By default, SSL will not be used.
User	The user id to login as.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


Abort	Abort Current Upload/Download.
Config	Sets or retrieves a configuration setting.
CreateMDNReceipt	Creates MDNReceipt .
DeleteFile	Remove a file specified by FileName from an FTP server.
GetFileSize	Gets the size of a file on the FTP server.
GetFileTime	Gets the last modification time of a file on the FTP server.
ListDirectory	List the current directory on an FTP server.
ListDirectoryLong	List the current directory on an FTP server.
Logoff	Logoff from the FTP server by posting a QUIT command.
Logon	Logon to the FTP RemoteHost using the current User and Password .
ParseRequest	Parses the EDI message and determines the EDIData .
ProcessRequest	Processes the EDI data, and generates the receipt.
ReadRequest	Reads the AS3 request from the FTP server.
SendResponse	Uploads the MDN receipt.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


ConnectionStatus	Fired to indicate changes in connection state.
DirList	Fired when a directory entry is received.
EndTransfer	Fired when a file completes downloading/uploading.
Error	Information about errors during data delivery.
PITrail	Traces the commands sent to the server, and the respective replies.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a file starts downloading/uploading.
Transfer	Fired during file download/upload.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


PortRange	Allows the specification of a port range where the component listens for active mode connections.
ActiveModePORTAddress	Allows the specification of the PORT address value for active mode connections.
UseRemoteHostAddressForPassive	Instructs component to use the in passive mode
MaxDirEntries	Instructs component to save the amount of entries specified that are returned by the server after a ListDirectory call has been made.
UseEPSV	Allows extended passive mode
CalculatePercentDone	Enables or Disables calculating the percent complete for downloads.
UseOldAUTHSSL	Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'.
UseProtWhenImplicit	Sends the PROT P command to the server.
UseClearChannel	Allows for the Clear Command Channel (CCC) command
UseClearDataChannel	Allows for the PROT C command
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
SSLProvider	The name of the security provider to use.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLSecurityFlags	Flags that control certificate verification
ReuseSSLSession	Determines if the SSL session is reused.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCADir	The path to a directory containing CA certificates.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).