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 | 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.
AttachmentCount	The number of records in the Attachment arrays.
AttachmentContentType	The MIME content-type of this ediattachment.
AttachmentFileName	The file name where the attachment data is stored.
AttachmentHeaders	The component fills out Headers each time any of the other properties for that ediattachment are changed.
CertEffectiveDate	The date which this certificate becomes valid.
CertEncoded	The certificate (PEM/base64 encoded).
CertExpirationDate	The date the certificate expires.
CertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
CertIssuer	The issuer of the certificate.
CertKeyPassword	The password for the certificate's private key (if any).
CertPrivateKey	The private key of the certificate (if available).
CertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
CertPublicKey	The public key of the certificate.
CertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
CertPublicKeyLength	The length of the certificate public key (in bits).
CertSerialNumber	The serial number of the certificate encoded as a string.
CertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
CertStore	The name of the certificate store for the client certificate.
CertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
CertStoreType	The type of certificate store for this certificate.
CertSubject	The subject of the certificate used for client authentication.
CertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
CertThumbprintMD5	MD5 hash of the certificate.
CertThumbprintSHA1	SHA1 hash of the certificate.
CertUsage	Textual description of UsageFlags .
CertUsageFlags	Flags that show intended use for the certificate.
CertVersion	The certificate's version number.
CompressionFormat	The compression format used on the incoming message.
Connected	Shows whether the component is connected.
EDIData	This property contains the EDI payload of the transmission.
EDIEDIType	The Content-Type of the EDI message.
EDIFileName	In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission.
EDIName	Name is the final name to be associated with the contents of either the Data or FileName properties.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
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.
MDNContent	This contains the entire content of the MDN Receipt.
MDNHeaders	ReceiptHeaders contains the AS2 headers of the MDN Receipt.
MDNMDN	MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.
MDNMessage	The human-readable portion of the MDN receipt.
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the original EDI message.
MDNSigningProtocol	This property contains the MIME type of the signature used, if any (i.
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 log in.
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.
RequestHeaderCount	The number of records in the RequestHeader arrays.
RequestHeaderField	This property contains the name of the HTTP header (same case as it is delivered).
RequestHeaderValue	This property contains the header contents.
RequestHeadersString	The headers in the AS3 request.
ScanResult	The result of invoking ParseRequest.
SignerCertEffectiveDate	The date which this certificate becomes valid.
SignerCertEncoded	The certificate (PEM/base64 encoded).
SignerCertExpirationDate	The date the certificate expires.
SignerCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SignerCertIssuer	The issuer of the certificate.
SignerCertKeyPassword	The password for the certificate's private key (if any).
SignerCertPrivateKey	The private key of the certificate (if available).
SignerCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SignerCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SignerCertPublicKey	The public key of the certificate.
SignerCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SignerCertPublicKeyLength	The length of the certificate public key (in bits).
SignerCertSerialNumber	The serial number of the certificate encoded as a string.
SignerCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SignerCertStore	The name of the certificate store for the client certificate.
SignerCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SignerCertStoreType	The type of certificate store for this certificate.
SignerCertSubject	The subject of the certificate used for client authentication.
SignerCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SignerCertThumbprintMD5	MD5 hash of the certificate.
SignerCertThumbprintSHA1	SHA1 hash of the certificate.
SignerCertUsage	Textual description of UsageFlags .
SignerCertUsageFlags	Flags that show intended use for the certificate.
SignerCertVersion	The certificate's version number.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
SSLStartMode	Determines how the component starts the SSL negotiation. By default, SSL will not be used.
User	The user identifier to use for login.

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.


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