AS2Sender Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorksEDI_AS2Sender

Procedural Interface

 ipworksedi_as2sender_open();
 ipworksedi_as2sender_close($res);
 ipworksedi_as2sender_register_callback($res, $id, $function);
 ipworksedi_as2sender_get_last_error($res);
 ipworksedi_as2sender_get_last_error_code($res);
 ipworksedi_as2sender_set($res, $id, $index, $value);
 ipworksedi_as2sender_get($res, $id, $index);
 ipworksedi_as2sender_do_config($res, $configurationstring);
 ipworksedi_as2sender_do_doevents($res);
 ipworksedi_as2sender_do_interrupt($res);
 ipworksedi_as2sender_do_post($res);
 ipworksedi_as2sender_do_readasyncreceipt($res);
 ipworksedi_as2sender_do_reset($res);
 ipworksedi_as2sender_do_restart($res);
 ipworksedi_as2sender_do_sendcemrequest($res, $requestid);
 ipworksedi_as2sender_do_sendcemresponse($res, $requestid);
 ipworksedi_as2sender_do_setrequestheader($res, $headername, $headervalue);
 ipworksedi_as2sender_do_settpinfo($res, $profile);
 ipworksedi_as2sender_do_verifyreceipt($res);

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 class will apply message security if the appropriate certificates are specified. To sign the data, set SigningCert. To encrypt, set RecipientCerts. 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 class will request a signed MDN over an SHA1 hash.

The class supports both synchronous and asynchronous MDN receipt delivery. By default, the class 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 class. 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 class 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 class 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.