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

Available in: EDI | EDI/AS2

AS2Sender Component [IP*Works! EDI V8]

Properties Methods Events Configuration Settings

The AS2Sender component implements an AS2 / EDI-INT client.

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 AS2Sender component may be used to send EDI or other messages over HTTP/S, using the AS2 protocol. It may also be used to verify synchronous or asynchronous server responses.

A typical AS2 transaction is as follows:

(1) The sender sends an EDI document to the receiver using HTTP or HTTPS. Typically the document will be signed and encrypted (particularly if SSL is not used). A signed receipt will also be requested.

(2) The receiver decrypts the message and verifies the signature.

(3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message.

When sending an EDI message, the client should specify, at a minimum, AS2From and AS2To, URL, and EDIData. The Post method should then be invoked.

To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the component will apply message security if the appropriate certificates are specified. To sign the data, set SigningCert. To encrypt, set RecipientCert. If the recipient uses different certificates for signing and encryption it will also be necessary to set ReceiptSignerCert.

SSL will also be used if the scheme in URL is "https". If your trading partner is using a self-signed certificate, it will be necessary to set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.

The message may also be compressed by setting CompressionFormat.

To request a receipt, or Message Disposition Notification (MDN), simply set the MDNTo property. The MDNOptions property may be used to customize the request. By default, the component will request a signed MDN over an SHA1 hash.

The component supports both synchronous and asynchronous MDN receipt delivery. By default, the component requests synchronous MDN receipt delivery, and the MDN will be returned in the HTTP reply. To request asynchronous MDN delivery, set the MDNDeliveryOption to the URL where MDN's are to be delivered.

The HTTP reply will automatically be processed by the component. If an MDN was requested, Post will validate the MDN and (if signed) establish non-repudiation of receipt. Any errors or warnings will cause the component to throw an exception.

In either case, after the EDI transaction is processed successfully, the MDNReceipt will be populated with the appropriate values.

Validating Asynchronous MDNs

The component may also be used to process and verify asynchronous MDNs. To do this, you should invoke ReadAsyncReceipt. This will read the receipt from the current HTTP context (or from MDNReceipt, if set manually), and allow you to determine your trading partner's identity and the message ID. You should then set ReceiptSignerCert and OriginalContentMIC, and finally invoke VerifyReceipt.

Property List

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


AS2From	The AS2 Identifier of the sending system.
AS2To	The AS2 Identifier of the receiving system.
AS2Version	The version of AS2 being used.
AsyncMDNInfoDir	Path to a directory to store data used in verifying AsyncMDNs.
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.
CompressionFormat	The compression format (if any) to use.
CookieCount	The number of records in the Cookie arrays.
CookieDomain	The domain of a received cookie.
CookieExpiration	This property contains an expiration time for the cookie (if provided by the server).
CookieName	The name of the cookie.
CookiePath	This property contains a path name to limit the cookie to (if provided by the server).
CookieSecure	This property contains the security flag of the received cookie.
CookieValue	This property contains the value of the cookie.
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.
EncryptingAlgorithm	The algorithm used to encrypt the EDI data.
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.
From	The email address of the HTTP agent (optional).
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.
MDNDeliveryOption	A URL indicating how the receipt is to be delivered.
MDNOptions	Used to indicate the options requested for the MDN receipt.
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	Used to indicate that a message disposition notification is requested.
MessageId	The Id of the message.
OriginalContentMIC	The Message Integrity Check(s) (one-way hash) of the outgoing message.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
ReceiptSignerCertEffectiveDate	The date which this certificate becomes valid.
ReceiptSignerCertEncoded	The certificate (PEM/base64 encoded).
ReceiptSignerCertExpirationDate	The date the certificate expires.
ReceiptSignerCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
ReceiptSignerCertIssuer	The issuer of the certificate.
ReceiptSignerCertKeyPassword	The password for the certificate's private key (if any).
ReceiptSignerCertPrivateKey	The private key of the certificate (if available).
ReceiptSignerCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
ReceiptSignerCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
ReceiptSignerCertPublicKey	The public key of the certificate.
ReceiptSignerCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
ReceiptSignerCertPublicKeyLength	The length of the certificate public key (in bits).
ReceiptSignerCertSerialNumber	The serial number of the certificate encoded as a string.
ReceiptSignerCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
ReceiptSignerCertStore	The name of the certificate store for the client certificate.
ReceiptSignerCertStorePassword	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.
ReceiptSignerCertStoreType	The type of certificate store for this certificate.
ReceiptSignerCertSubject	The subject of the certificate used for client authentication.
ReceiptSignerCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
ReceiptSignerCertThumbprintMD5	MD5 hash of the certificate.
ReceiptSignerCertThumbprintSHA1	SHA1 hash of the certificate.
ReceiptSignerCertUsage	Textual description of UsageFlags .
ReceiptSignerCertUsageFlags	Flags that show intended use for the certificate.
ReceiptSignerCertVersion	The certificate's version number.
RecipientCertEffectiveDate	The date which this certificate becomes valid.
RecipientCertEncoded	The certificate (PEM/base64 encoded).
RecipientCertExpirationDate	The date the certificate expires.
RecipientCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
RecipientCertIssuer	The issuer of the certificate.
RecipientCertKeyPassword	The password for the certificate's private key (if any).
RecipientCertPrivateKey	The private key of the certificate (if available).
RecipientCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
RecipientCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
RecipientCertPublicKey	The public key of the certificate.
RecipientCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
RecipientCertPublicKeyLength	The length of the certificate public key (in bits).
RecipientCertSerialNumber	The serial number of the certificate encoded as a string.
RecipientCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
RecipientCertStore	The name of the certificate store for the client certificate.
RecipientCertStorePassword	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.
RecipientCertStoreType	The type of certificate store for this certificate.
RecipientCertSubject	The subject of the certificate used for client authentication.
RecipientCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
RecipientCertThumbprintMD5	MD5 hash of the certificate.
RecipientCertThumbprintSHA1	SHA1 hash of the certificate.
RecipientCertUsage	Textual description of UsageFlags .
RecipientCertUsageFlags	Flags that show intended use for the certificate.
RecipientCertVersion	The certificate's version number.
SigningCertEffectiveDate	The date which this certificate becomes valid.
SigningCertEncoded	The certificate (PEM/base64 encoded).
SigningCertExpirationDate	The date the certificate expires.
SigningCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SigningCertIssuer	The issuer of the certificate.
SigningCertKeyPassword	The password for the certificate's private key (if any).
SigningCertPrivateKey	The private key of the certificate (if available).
SigningCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SigningCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SigningCertPublicKey	The public key of the certificate.
SigningCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SigningCertPublicKeyLength	The length of the certificate public key (in bits).
SigningCertSerialNumber	The serial number of the certificate encoded as a string.
SigningCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SigningCertStore	The name of the certificate store for the client certificate.
SigningCertStorePassword	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.
SigningCertStoreType	The type of certificate store for this certificate.
SigningCertSubject	The subject of the certificate used for client authentication.
SigningCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SigningCertThumbprintMD5	MD5 hash of the certificate.
SigningCertThumbprintSHA1	SHA1 hash of the certificate.
SigningCertUsage	Textual description of UsageFlags .
SigningCertUsageFlags	Flags that show intended use for the certificate.
SigningCertVersion	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).
Subject	The subject of the message.
Timeout	A timeout for the component.
URL	The URL to post to.
UserAgent	Information about the user agent.

Method List

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


Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
Post	Post data to the AS2 server, and check the receipt.
ReadAsyncReceipt	Reads an asynchronous MDN receipt from the current HTTP session.
Reset	Resets the state of the control.
SetRequestHeader	Allows the user to set or add arbitrary HTTP request headers.
SetTPInfo	A convenient way to set AS2 communication parameters using XML strings.
VerifyReceipt	Verifies an asynchronous 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.


Connected	Fired immediately after a connection completes (or fails).
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
SetCookie	Fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

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


AcceptAnySignerCert	Used to trust any signing certificate when verifying a signature.
AS2Version	The version of AS2 to be used in the outgoing message.
Authorization	The Authorization string to be sent to the server.
BinarySignature	Uses binary encoding in signed messages.
EncodeToTempDir	A temporary directory to write outgoing requests to before they are sent.
FollowRedirects	Follows HTTP 302 redirects on Posts.
From	Sets the From header in an AS2 transmission.
LogOptions	The information to be written to log files.
PostToFile	Directs the post to a file on disk instead of to the trading partner's server.
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
Subject	The subject of the HTTP post.
UseCryptoAPI	Whether to use the Microsoft Crypto API for cryptographic message generation.
UserAgent	The User-Agent of the HTTP post.
HTTPAuthScheme	The authorization scheme to be used when server authorization is to be performed.
HTTPUser	A user name if authentication is to be used.
HTTPPassword	A password if authentication is to be used.
CodePage	The system code page used for Unicode to Multibyte translations.