AS2Sender Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

AS2Sender

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 control 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 control will request a signed MDN over an SHA1 hash.

The control supports both synchronous and asynchronous MDN receipt delivery. By default, the control 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 control. 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 control 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 control 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 control with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AS2From Property (AS2Sender Control)

The AS2 Identifier of the sending system.

Syntax

as2sendercontrol.AS2From[=string]

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

Data Type

String

AS2To Property (AS2Sender Control)

The AS2 Identifier of the receiving system.

Syntax

as2sendercontrol.AS2To[=string]

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

Data Type

String

AS2Version Property (AS2Sender Control)

The version of AS2 being used.

Syntax

as2sendercontrol.AS2Version

Default Value

"1.2"

Remarks

The version of AS2 being used.

This property is read-only.

Data Type

String

AsyncMDNInfoDir Property (AS2Sender Control)

Path to a directory to store data used in verifying AsyncMDNs.

Syntax

as2sendercontrol.AsyncMDNInfoDir[=string]

Default Value

""

Remarks

If Post is invoked after setting AsyncMDNInfoDir and an asynchronous MDN is requested, the control stores the data required to verify AsyncMDNs in a file in the specified directory. The name of the file is the MessageId of the outgoing message.

AsyncMDNInfoDir is also used while verifying asynchronous MDNs using VerifyReceipt. The properties required to process AsyncMDNs, namely OriginalContentMIC and MDNOptions, are automatically read from the file saved at the time of sending the original message.

Data Type

String

AttachmentCount Property (AS2Sender Control)

The number of records in the Attachment arrays.

Syntax

as2sendercontrol.AttachmentCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFilename
• AttachmentHeaders
• AttachmentName

The array indices start at 0 and end at AttachmentCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (AS2Sender Control)

The MIME content-type of this ediattachment .

Syntax

as2sendercontrol.AttachmentContentType(AttachmentIndex)[=string]

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentData Property (AS2Sender Control)

This property contains the attachment data.

Syntax

as2sendercontrol.AttachmentData(AttachmentIndex)[=string]

Default Value

""

Remarks

This property contains the attachment data.

In a receiver, the control decodes the attachment to the AttachmentData property when AttachmentData's value is first queried. This property will contain the full decrypted text of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.

This property is not available at design time.

Data Type

Binary String

AttachmentFilename Property (AS2Sender Control)

The file name of the attachment.

Syntax

as2sendercontrol.AttachmentFilename(AttachmentIndex)[=string]

Default Value

""

Remarks

The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the AttachmentHeaders.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentHeaders Property (AS2Sender Control)

The control fills out Headers each time any of the other properties for that ediattachment are changed.

Syntax

as2sendercontrol.AttachmentHeaders(AttachmentIndex)[=string]

Default Value

""

Remarks

The control fills out AttachmentHeaders each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (AS2Sender Control)

Name is the final name to be associated with the contents of either the Data or Filename properties.

Syntax

as2sendercontrol.AttachmentName(AttachmentIndex)[=string]

Default Value

""

Remarks

AttachmentName is the final name to be associated with the contents of either the AttachmentData or AttachmentFilename properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

CEMCount Property (AS2Sender Control)

The number of records in the CEM arrays.

Syntax

as2sendercontrol.CEMCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CEMAccepted
• CEMCertId
• CEMCertIssuer
• CEMCertSerialNumber
• CEMCertStore
• CEMCertStorePassword
• CEMCertStoreType
• CEMCertSubject
• CEMCertUsage
• CEMRejectionReason
• CEMRespondByDate
• CEMResponseURL

The array indices start at 0 and end at CEMCount - 1.

This property is not available at design time.

Data Type

Integer

CEMAccepted Property (AS2Sender Control)

Whether the CEM request is accepted.

Syntax

as2sendercontrol.CEMAccepted(CEMIndex)[=boolean]

Default Value

False

Remarks

Whether the CEM request is accepted.

Before calling SendCEMResponse set this to True to accept the CEM request.

When processing a CEM response check this property to determine if the request was accepted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Boolean

CEMCertId Property (AS2Sender Control)

A user defined identifier for the certificate.

Syntax

as2sendercontrol.CEMCertId(CEMIndex)[=string]

Default Value

""

Remarks

A user defined identifier for the certificate.

This property defines a user specified identifier for the certificate. This may be set to a value which helps the recipient identify the certificate. For instance "CompanyA.Encryption.Cert.2014".

This property may be set before calling SendCEMRequest or SendCEMResponse from AS2Sender.

This property may be queried when received a CEM request or response with AS2Receiver.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertIssuer Property (AS2Sender Control)

This property holds the issuer of the certificate.

Syntax

as2sendercontrol.CEMCertIssuer(CEMIndex)[=string]

Default Value

""

Remarks

This property holds the issuer of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertSerialNumber Property (AS2Sender Control)

This property holds the serial number of the certificate.

Syntax

as2sendercontrol.CEMCertSerialNumber(CEMIndex)[=string]

Default Value

""

Remarks

This property holds the serial number of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStore Property (AS2Sender Control)

The name of the certificate store for the certificate.

Syntax

as2sendercontrol.CEMCertStore(CEMIndex)[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the certificate.

This property defines the store location for the type specified by CEMCertStoreType.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CEMCertStoreB.

This property is not available at design time.

Data Type

Binary String

CEMCertStorePassword Property (AS2Sender Control)

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.

Syntax

as2sendercontrol.CEMCertStorePassword(CEMIndex)[=string]

Default Value

""

Remarks

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.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStoreType Property (AS2Sender Control)

The type of certificate store for this certificate.

Syntax

as2sendercontrol.CEMCertStoreType(CEMIndex)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMCertSubject Property (AS2Sender Control)

The subject of the certificate.

Syntax

as2sendercontrol.CEMCertSubject(CEMIndex)[=string]

Default Value

""

Remarks

The subject of the certificate.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertUsage Property (AS2Sender Control)

This property defines which usages are applicable to the certificate.

Syntax

as2sendercontrol.CEMCertUsage(CEMIndex)[=integer]

Default Value

15

Remarks

This property defines which usages are applicable to the certificate. This may be set to a binary 'OR' of one or more of the following values:

• 1 (TLS Client)
• 2 (TLS Server)
• 4 (Encryption)
• 8 (Signature)

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMRejectionReason Property (AS2Sender Control)

If Accepted is False this property specifies the reason a request was rejected.

Syntax

as2sendercontrol.CEMRejectionReason(CEMIndex)[=string]

Default Value

""

Remarks

If CEMAccepted is False this property specifies the reason a request was rejected.

When using AS2Sender this may be set to a string value which the recipient will see.

When using AS2Receiver query this property for details on why the request was rejected.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMRespondByDate Property (AS2Sender Control)

This property specifies the date by which the other party should respond.

Syntax

as2sendercontrol.CEMRespondByDate(CEMIndex)[=string]

Default Value

""

Remarks

This property specifies the date by which the other party should respond. If the other party does not respond the new certificate may be used without any further notice. This property exists to assist the recipient in knowing when they should respond by. It does not guarantee a response by the specified date.

The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".

When using AS2Sender set this before calling SendCEMRequest.

When using AS2Receiver this property may be queried.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMResponseURL Property (AS2Sender Control)

This property defines the URL to which the response should be sent.

Syntax

as2sendercontrol.CEMResponseURL(CEMIndex)[=string]

Default Value

""

Remarks

This property defines the URL to which the response should be sent.

When using AS2Sender set this property before calling SendCEMRequest. This tells the recipient where to send the response.

When using AS2Receiver query this property to determine the URL where the response should be sent.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CompressionFormat Property (AS2Sender Control)

The compression format (if any) to use.

Syntax

as2sendercontrol.CompressionFormat[=integer]

Possible Values

tcfNone(0), 
tcfZLIB(1)

Default Value

0

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the control to compress the outgoing data using the indicated format.

Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required.

The compression algorithm used is Zlib, as required by RFC 3274 and defined in RFCs 1950 and 1951.

Data Type

Integer

CookieCount Property (AS2Sender Control)

The number of records in the Cookie arrays.

Syntax

as2sendercontrol.CookieCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (AS2Sender Control)

This is the domain of a received cookie.

Syntax

as2sendercontrol.CookieDomain(CookieIndex)

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieExpiration Property (AS2Sender Control)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

as2sendercontrol.CookieExpiration(CookieIndex)

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieName Property (AS2Sender Control)

This property, contains the name of the cookie.

Syntax

as2sendercontrol.CookieName(CookieIndex)[=string]

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (AS2Sender Control)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

as2sendercontrol.CookiePath(CookieIndex)

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieSecure Property (AS2Sender Control)

This property contains the security flag of the received cookie.

Syntax

as2sendercontrol.CookieSecure(CookieIndex)

Default Value

False

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CookieValue Property (AS2Sender Control)

This property contains the value of the cookie.

Syntax

as2sendercontrol.CookieValue(CookieIndex)[=string]

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

EDIData Property (AS2Sender Control)

This property contains the EDI payload of the transmission.

Syntax

as2sendercontrol.EDIData[=string]

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.

The EDI message to send.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .EDIDataB.

This property is not available at design time.

Data Type

Binary String

EDIType Property (AS2Sender Control)

The Content-Type of the EDI message.

Syntax

as2sendercontrol.EDIType[=string]

Default Value

""

Remarks

The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".

This property is not available at design time.

Data Type

String

EDIFilename Property (AS2Sender Control)

In a sender, if Filename is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

as2sendercontrol.EDIFilename[=string]

Default Value

""

Remarks

In a sender, if EDIFilename is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.

In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.

Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.

This property is not available at design time.

Data Type

String

EDIName Property (AS2Sender Control)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

as2sendercontrol.EDIName[=string]

Default Value

"rfc1767.edi"

Remarks

EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (AS2Sender Control)

The algorithm used to encrypt the EDI data.

Syntax

as2sendercontrol.EncryptionAlgorithm[=string]

Default Value

"3DES"

Remarks

If RecipientCerts contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The control supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The control supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

Possible values are:

• 3DES (default)
• DES
• AESCBC128
• AESCBC192
• AESCBC256
• AESGCM128
• AESGCM192
• AESGCM256

Data Type

String

Etag Property (AS2Sender Control)

The Etag of the file being sent.

Syntax

as2sendercontrol.Etag[=string]

Default Value

""

Remarks

This specifies the Etag for the file. This value should be set to an empty string the first time a file is sent using the Restart command. The control will generate a unique Etag based on the processed contents of the file and set this property when sending begins.

If a file is interrupted, this value must be set when Restart is called to resume transfer of the already processed file.

Data Type

String

FirewallAutoDetect Property (AS2Sender Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

as2sendercontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AS2Sender Control)

This property determines the type of firewall to connect through.

Syntax

as2sendercontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AS2Sender Control)

This property contains the name or IP address of firewall (optional).

Syntax

as2sendercontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (AS2Sender Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

as2sendercontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AS2Sender Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

as2sendercontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AS2Sender Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

as2sendercontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

From Property (AS2Sender Control)

The email address of the HTTP agent (optional).

Syntax

as2sendercontrol.From[=string]

Default Value

""

Remarks

If the From property contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

This property is not available at design time.

Data Type

String

LocalHost Property (AS2Sender Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

as2sendercontrol.LocalHost[=string]

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LogDirectory Property (AS2Sender Control)

The path to a directory for logging.

Syntax

as2sendercontrol.LogDirectory[=string]

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the control will log the complete text of the outgoing request and the incoming response.

The control will write multiple log file for each transmission, with separate extensions for each type of data:

One or more of these logs may be disabled by setting the LogOptions configuration setting.

LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the control will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the control. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension.

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (AS2Sender Control)

The log file written.

Syntax

as2sendercontrol.LogFile

Default Value

""

Remarks

If LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files written, minus the extension.

The control will write multiple log files for each transmission, with separate extensions for each type of data:

This property is read-only.

Data Type

String

MDNDeliveryOption Property (AS2Sender Control)

A URL indicating how the receipt is to be delivered.

Syntax

as2sendercontrol.MDNDeliveryOption[=string]

Default Value

""

Remarks

The default mode of operation is for the receipt to be returned synchronously within the HTTP reply. By specifying a valid URL, the user may request asynchronous delivery instead. The URL indicates the destination for the reply, and may use any appropriate protocol, such as "http", "https", or "mailto".

If MDNDeliveryOption is set to an empty string, the receipt will be returned synchronously, and will be processed automatically by the control. Clients requesting asynchronous delivery should provide their own processing for reading receipts.

Data Type

String

MDNOptions Property (AS2Sender Control)

Used to indicate the options requested for the MDN receipt.

Syntax

as2sendercontrol.MDNOptions[=string]

Default Value

"signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256"

Remarks

By default, the control will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard.

Set MDNOptions to an empty string to request an unsigned receipt.

This property will automatically be updated when SignatureAlgorithm is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value.

The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm.

Data Type

String

MDNReceiptContent Property (AS2Sender Control)

This contains the entire content of the MDN Receipt.

Syntax

as2sendercontrol.MDNReceiptContent[=string]

Default Value

""

Remarks

This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable MDNReceiptMDN (Message Disposition Notification) and a human readable MDNReceiptMessage, which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .MDNReceiptContentB.

Data Type

Binary String

MDNReceiptHeaderCount Property (AS2Sender Control)

The number of headers in the MDN.

Syntax

as2sendercontrol.MDNReceiptHeaderCount

Default Value

0

Remarks

The number of headers in the MDN.

This property is read-only and not available at design time.

Data Type

Integer

MDNReceiptHeaderField Property (AS2Sender Control)

The property name of the MDN header currently selected by HeaderIndex .

Syntax

as2sendercontrol.MDNReceiptHeaderField

Default Value

""

Remarks

The field name of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only and not available at design time.

Data Type

String

MDNReceiptHeaderIndex Property (AS2Sender Control)

Which MDN header is currently selected to populate HeaderField and HeaderValue .

Syntax

as2sendercontrol.MDNReceiptHeaderIndex[=integer]

Default Value

0

Remarks

Which MDN header is currently selected to populate MDNReceiptHeaderField and MDNReceiptHeaderValue.

Valid values are 0 to MDNReceiptHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MDNReceiptHeaders Property (AS2Sender Control)

Headers contains all of the headers of the AS2 MDN Receipt as a single string.

Syntax

as2sendercontrol.MDNReceiptHeaders[=string]

Default Value

""

Remarks

Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).

You can also use MDNReceiptHeaderCount, MDNReceiptHeaderIndex, MDNReceiptHeaderField, and MDNReceiptHeaderValue to easily iterate through each individual header.

Data Type

String

MDNReceiptHeaderValue Property (AS2Sender Control)

The value of the MDN header currently selected by HeaderIndex .

Syntax

as2sendercontrol.MDNReceiptHeaderValue

Default Value

""

Remarks

The value of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only and not available at design time.

Data Type

String

MDNReceiptMDN Property (AS2Sender Control)

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.

Syntax

as2sendercontrol.MDNReceiptMDN

Default Value

""

Remarks

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.

This property is read-only.

Data Type

String

MDNReceiptMessage Property (AS2Sender Control)

The human-readable portion of the MDN receipt.

Syntax

as2sendercontrol.MDNReceiptMessage

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.

This property is read-only.

Data Type

String

MDNReceiptMICValue Property (AS2Sender Control)

The Message Integrity Check(s) (one-way hash) of the original EDI message.

Syntax

as2sendercontrol.MDNReceiptMICValue

Default Value

""

Remarks

The Message Integrity Check(s) (one-way hash) of the original EDI message.

An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".

This property is read-only.

Data Type

String

MDNReceiptSigningProtocol Property (AS2Sender Control)

This property contains the MIME type of the signature used, if any (i.

Syntax

as2sendercontrol.MDNReceiptSigningProtocol

Default Value

""

Remarks

This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.

This property is read-only.

Data Type

String

MDNTo Property (AS2Sender Control)

Used to indicate that a message disposition notification is requested.

Syntax

as2sendercontrol.MDNTo[=string]

Default Value

""

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. The value may be an email address, URL, etc., and while its presence is used to determine whether or not an MDN is sent, the value itself will typically be ignored by the server.

By default, the control will request a PKCS#7 signature and synchronous delivery. You may set MDNDeliveryOption to request an asynchronous MDN, and you may set MDNOptions to request a different type of signature, or no signature at all.

Data Type

String

MessageId Property (AS2Sender Control)

The Id of the message.

Syntax

as2sendercontrol.MessageId[=string]

Default Value

""

Remarks

The Id format is as in RFC 2822: id-left@id-right .

A unique Id will automatically be generated on startup. Sending a message will reset id-left if the MessageId has been used in the previous message.

If you set MessageId to a string of the form "@(id-right)" a unique id-left will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same id-right.

After an MDNReceipt is returned or set, MessageId will contain the Original-Message-ID found in the MDN Receipt.

This property is not available at design time.

Data Type

String

OriginalContentMIC Property (AS2Sender Control)

The Message Integrity Check(s) (one-way hash) of the outgoing message.

Syntax

as2sendercontrol.OriginalContentMIC[=string]

Default Value

""

Remarks

A MIC will be calculated over the outgoing message using the same algorithm in the SignatureAlgorithm configuration used to sign the message. The property will be set when Post (in AS3, Send) is invoked, and the MIC will automatically be checked against the Original-Content-MIC in the MDN for synchronous MDNs.

The format is in RFC 3335, i.e. "w7AguNJEmhF/qIjJw6LnnA==, md5", with a newline at the end.

If you are requesting an asynchronous MDN, you must save this value externally so that it can be loaded when the MDN is received (you may also use AsyncMDNInfoDir).

Data Type

String

ProxyAuthScheme Property (AS2Sender Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

as2sendercontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AS2Sender Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

as2sendercontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (AS2Sender Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

as2sendercontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AS2Sender Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

as2sendercontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AS2Sender Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

as2sendercontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AS2Sender Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

as2sendercontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AS2Sender Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

as2sendercontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ReceiptSignerCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.ReceiptSignerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ReceiptSignerCertStore and ReceiptSignerCertSubject properties also may be used to specify a certificate.

When ReceiptSignerCertEncoded is set, a search is initiated in the current ReceiptSignerCertStore for the private key of the certificate. If the key is found, ReceiptSignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, ReceiptSignerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ReceiptSignerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

ReceiptSignerCertStore Property (AS2Sender Control)

This is the name of the certificate store for the client certificate.

Syntax

as2sendercontrol.ReceiptSignerCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ReceiptSignerCertStoreType property denotes the type of the certificate store specified by ReceiptSignerCertStore. If the store is password protected, specify the password in ReceiptSignerCertStorePassword.

ReceiptSignerCertStore is used in conjunction with the ReceiptSignerCertSubject property to specify client certificates. If ReceiptSignerCertStore has a value, and ReceiptSignerCertSubject or ReceiptSignerCertEncoded is set, a search for a certificate is initiated. Please see the ReceiptSignerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ReceiptSignerCertStoreB.

Data Type

Binary String

ReceiptSignerCertStorePassword Property (AS2Sender Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

as2sendercontrol.ReceiptSignerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ReceiptSignerCertStoreType Property (AS2Sender Control)

This is the type of certificate store for this certificate.

Syntax

as2sendercontrol.ReceiptSignerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

ReceiptSignerCertSubject Property (AS2Sender Control)

This is the subject of the certificate used for client authentication.

Syntax

as2sendercontrol.ReceiptSignerCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

RecipientCertCount Property (AS2Sender Control)

The number of records in the RecipientCert arrays.

Syntax

as2sendercontrol.RecipientCertCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject

The array indices start at 0 and end at RecipientCertCount - 1.

This property is not available at design time.

Data Type

Integer

RecipientCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.RecipientCertEncoded(RecipientCertIndex)[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertEncodedB.

This property is not available at design time.

Data Type

Binary String

RecipientCertStore Property (AS2Sender Control)

This is the name of the certificate store for the client certificate.

Syntax

as2sendercontrol.RecipientCertStore(RecipientCertIndex)[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertStoreB.

This property is not available at design time.

Data Type

Binary String

RecipientCertStorePassword Property (AS2Sender Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

as2sendercontrol.RecipientCertStorePassword(RecipientCertIndex)[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (AS2Sender Control)

This is the type of certificate store for this certificate.

Syntax

as2sendercontrol.RecipientCertStoreType(RecipientCertIndex)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Integer

RecipientCertSubject Property (AS2Sender Control)

This is the subject of the certificate used for client authentication.

Syntax

as2sendercontrol.RecipientCertSubject(RecipientCertIndex)[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

String

RestartDirectory Property (AS2Sender Control)

The directory to log cached files when using AS2 restart functionality.

Syntax

as2sendercontrol.RestartDirectory[=string]

Default Value

""

Remarks

If this property is set, the control will cache all data to the RestartDirectory. Thus, when sending a file is interrupted, the control can restart the transmission of the file starting where it was interrupted.

To use this functionality, simply set the RestartDirectory and call Restart.

When using restart functionality, the data is completely processed to the RestartDirectory before sending begins.

NOTE: This directory will not automatically be cleaned up.

Data Type

String

RolloverSigningCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.RolloverSigningCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RolloverSigningCertStore and RolloverSigningCertSubject properties also may be used to specify a certificate.

When RolloverSigningCertEncoded is set, a search is initiated in the current RolloverSigningCertStore for the private key of the certificate. If the key is found, RolloverSigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RolloverSigningCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RolloverSigningCertEncodedB.

This property is not available at design time.

Data Type

Binary String

RolloverSigningCertStore Property (AS2Sender Control)

This is the name of the certificate store for the client certificate.

Syntax

as2sendercontrol.RolloverSigningCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RolloverSigningCertStoreType property denotes the type of the certificate store specified by RolloverSigningCertStore. If the store is password protected, specify the password in RolloverSigningCertStorePassword.

RolloverSigningCertStore is used in conjunction with the RolloverSigningCertSubject property to specify client certificates. If RolloverSigningCertStore has a value, and RolloverSigningCertSubject or RolloverSigningCertEncoded is set, a search for a certificate is initiated. Please see the RolloverSigningCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RolloverSigningCertStoreB.

Data Type

Binary String

RolloverSigningCertStorePassword Property (AS2Sender Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

as2sendercontrol.RolloverSigningCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

RolloverSigningCertStoreType Property (AS2Sender Control)

This is the type of certificate store for this certificate.

Syntax

as2sendercontrol.RolloverSigningCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

RolloverSigningCertSubject Property (AS2Sender Control)

This is the subject of the certificate used for client authentication.

Syntax

as2sendercontrol.RolloverSigningCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SignatureAlgorithm Property (AS2Sender Control)

Signature algorithm to be used in outgoing messages.

Syntax

as2sendercontrol.SignatureAlgorithm[=string]

Default Value

"sha-256"

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

• sha1
• md5
• sha-256 (or sha256) (default)
• sha-384 (or sha384)
• sha-512 (or sha512)
• sha-224 (or sha224)

The default value is "sha-256". When this property is set the MDNOptions property is automatically updated to request the MDN receipt be signed with the same algorithm.

Data Type

String

SigningCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.SigningCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

When SigningCertEncoded is set, a search is initiated in the current SigningCertStore for the private key of the certificate. If the key is found, SigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SigningCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SigningCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SigningCertStore Property (AS2Sender Control)

This is the name of the certificate store for the client certificate.

Syntax

as2sendercontrol.SigningCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password protected, specify the password in SigningCertStorePassword.

SigningCertStore is used in conjunction with the SigningCertSubject property to specify client certificates. If SigningCertStore has a value, and SigningCertSubject or SigningCertEncoded is set, a search for a certificate is initiated. Please see the SigningCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SigningCertStoreB.

Data Type

Binary String

SigningCertStorePassword Property (AS2Sender Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

as2sendercontrol.SigningCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SigningCertStoreType Property (AS2Sender Control)

This is the type of certificate store for this certificate.

Syntax

as2sendercontrol.SigningCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SigningCertSubject Property (AS2Sender Control)

This is the subject of the certificate used for client authentication.

Syntax

as2sendercontrol.SigningCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AS2Sender Control)

This is the name of the certificate store for the client certificate.

Syntax

as2sendercontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AS2Sender Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

as2sendercontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AS2Sender Control)

This is the type of certificate store for this certificate.

Syntax

as2sendercontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AS2Sender Control)

This is the subject of the certificate used for client authentication.

Syntax

as2sendercontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (AS2Sender Control)

This specifies the SSL/TLS implementation to use.

Syntax

as2sendercontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (AS2Sender Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2sendercontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Subject Property (AS2Sender Control)

The subject of the message.

Syntax

as2sendercontrol.Subject[=string]

Default Value

""

Remarks

The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer.

Data Type

String

Timeout Property (AS2Sender Control)

A timeout for the control.

Syntax

as2sendercontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

URL Property (AS2Sender Control)

The URL to which the request is made.

Syntax

as2sendercontrol.URL[=string]

Default Value

""

Remarks

This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https".

Data Type

String

UseOAEP Property (AS2Sender Control)

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

as2sendercontrol.UseOAEP[=boolean]

Default Value

False

Remarks

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the control will use PKCS1.

To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams

Data Type

Boolean

UsePSS Property (AS2Sender Control)

This property specifies whether or not RSA-PSS will be used during signing and verification.

Syntax

as2sendercontrol.UsePSS[=boolean]

Default Value

False

Remarks

This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.

Data Type

Boolean

UserAgent Property (AS2Sender Control)

Information about the user agent.

Syntax

as2sendercontrol.UserAgent[=string]

Default Value

"IPWorks EDI AS2Sender Component - www.nsoftware.com"

Remarks

You may override the default with the name and version of your software.

Data Type

String

Config Method (AS2Sender Control)

Sets or retrieves a configuration setting.

Syntax

as2sendercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (AS2Sender Control)

Processes events from the internal message queue.

Syntax

as2sendercontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (AS2Sender Control)

Interrupt the current method.

Syntax

as2sendercontrol.Interrupt 

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Post Method (AS2Sender Control)

Post data to the AS2 server, and check the receipt.

Syntax

as2sendercontrol.Post 

Remarks

Post data to the server. The reply will also be checked, and if a synchronous MDN was requested (i.e., MDNTo is not empty), it will be validated. After the method finishes, the MDNReceipt, ReceiptSigningProtocol, and ReceiptSignerCert properties will be populated with the appropriate values.

The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN.

If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal.

ReadAsyncReceipt Method (AS2Sender Control)

Reads an asynchronous MDN receipt from the current HTTP session.

Syntax

as2sendercontrol.ReadAsyncReceipt 

Remarks

ReadAsyncReceipt is used to read an asynchronous MDN receipt from the . The control will fetch the request stream from the HTTP session. MDNReceipt will be populated with a new instance of MDNReceipt.

Reset Method (AS2Sender Control)

Resets the state of the control.

Syntax

as2sendercontrol.Reset 

Remarks

Resets all HTTP headers as well as EDIData, etc. After invoking this method the control may be reused as if it were newly created.

Restart Method (AS2Sender Control)

Restart sending of the file specified by the Etag property.

Syntax

as2sendercontrol.Restart 

Remarks

This method should be called when using the AS2 restart functionality. When called, the control will process the file and cache the processed contents to the RestartDirectory. Before sending, the Etag property will be populated with a unique Etag which identifies the processed file.

If sending is interrupted or fails, this method should be called to restart sending of the previously processed file starting where the interruption occurred. In order to restart from the last transfer, the Etag must be populated with the value from the last connection.

NOTE: When using restart functionality, the data is completely processed to the RestartDirectory before sending begins.

SendCEMRequest Method (AS2Sender Control)

Sends a Certificate Exchange Messaging (CEM) request.

Syntax

as2sendercontrol.SendCEMRequest RequestId

Remarks

This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails.

Certificate Exchange Messaging (CEM) allows for new certificates to be sent to a recipient and be automatically updated. This removes the requirement to manually send new certificates to a partner via email or other means. When both sides support this functionality updating certificates can be accomplished in a short period of time.

To prepare a CEM request populate the CEMDetails collection with at least one certificate. For instance if the certificate of the application will be updated soon, the CEMDetails may be populated with the corresponding public certificate to be sent to your partner. CEMDetails should only contain public certificates.

Set CEMRespondByDate to the date by which you expect a response. The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".

Optionally set CEMCertId to a friendly identifier that the partner may use to help understand the purpose of the new certificate. For instance "New.Encryption.Cert.2014".

Set CEMResponseURL to the publicly accessible URL where the CEM response will be sent after the partner processes it.

The RequestId parameter uniquely identifies this CEM request and must be saved for use later when receiving the CEM response.

When calling this method the applicable CEMDetails properties are:

• CEMCertStoreType
• CEMCertStore
• CEMCertStorePassword
• CEMCertSubject
• CEMRespondByDate
• CEMResponseURL
• CEMCertUsage (optional)
• CEMCertId (optional)

SendCEMResponse Method (AS2Sender Control)

Sends a Certificate Exchange Messaging (CEM) response.

Syntax

as2sendercontrol.SendCEMResponse RequestId

Remarks

This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails.

A CEM request must have previously been received using AS2Receiver. To send the CEM response, populate CEMDetails with the certificate information and decide whether to accept or reject the request. The following properties may be set to specify the certificate:

• CEMCertStoreType
• CEMCertStore
• CEMCertSubject

• CEMCertIssuer
• CEMCertSerialNumber

After specifying the certificate information choose whether to accept or reject the request. To accept the request set CEMAccepted to True. To reject the request set CEMAccepted to False and specify a reason in CEMRejectionReason.

Call SendCEMResponse and pass the CEM request Id that was retrieved from the request.

SetRequestHeader Method (AS2Sender Control)

Allows the user to set or add arbitrary HTTP request headers.

Syntax

as2sendercontrol.SetRequestHeader HeaderName, HeaderValue

Remarks

HeaderName should contain the header name, and HeaderValue should contain its value. Use this to set headers such as To, Date, etc. Note that a default value for Date will automatically be determined and this method may be used to override the default.

SetRequestHeader may be used to set any header except for the following: AS2-To, AS2-From, AS2-Version, Subject, Message-Id, Disposition-Notification-To, Disposition-Notification-Options, Receipt-Delivery-Option, Host, Content-Length.

SetTPInfo Method (AS2Sender Control)

A convenient way to set AS2 communication parameters using XML strings.

Syntax

as2sendercontrol.SetTPInfo Profile

Remarks

SetTPInfo offers a convenient way to set AS2 communication parameters using XML strings. The format of the XML is the same as provided by the method GetTPInfo of AS2ProfileMgr.

The "self" information should always precede the partner information as shown below. AS2Sender as2sender = new AS2Sender(); AS2Profilemgr mgr = new AS2Profilemgr(); mgr.DataDir = @"C:\as2data"; as2sender.SetTPInfo(mgr.GetTPInfo("self")); as2sender.SetTPInfo(mgr.GetTPInfo("partnerOrg")); as2sender.EDIFile = @"C:\as2Data.x12"; as2sender.Post();

VerifyReceipt Method (AS2Sender Control)

Verifies an asynchronous MDN receipt.

Syntax

as2sendercontrol.VerifyReceipt 

Remarks

VerifyReceipt verifies the receipt in MDNReceipt against OriginalContentMIC, MessageId and the preferences specified in MDNOptions. The method operates similarly to Post: After the method finishes, the MDNReceipt, ReceiptSigningProtocol, and ReceiptSignerCert properties will be populated with the appropriate values.

The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN.

If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal.

This method should be used to verify receipts received asynchronously; i.e., not in the HTTP reply to a POST. When posting, asynchronous MDN delivery may be requested by setting MDNDeliveryOption.

Connected Event (AS2Sender Control)

This event is fired immediately after a connection completes (or fails).

Syntax

Sub as2sendercontrol_Connected(StatusCode As Integer, Description As String)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Disconnected Event (AS2Sender Control)

This event is fired when a connection is closed.

Syntax

Sub as2sendercontrol_Disconnected(StatusCode As Integer, Description As String)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

EndTransfer Event (AS2Sender Control)

This event is fired when a document finishes transferring.

Syntax

Sub as2sendercontrol_EndTransfer(Direction As Integer)

Remarks

The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AS2Sender Control)

Fired when information is available about errors during data delivery.

Syntax

Sub as2sendercontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AS2Sender Control)

This event is fired every time a header line comes in.

Syntax

Sub as2sendercontrol_Header(Field As String, Value As String)

Remarks

The Field parameter contains the name of the HTTP header (same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains an empty string.

Note that only the top-level headers will be returned through this event, and that they are available through the ReplyHeaders property.

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (AS2Sender Control)

Fired with log information while processing a message.

Syntax

Sub as2sendercontrol_Log(LogType As String, LogMessage As String)

Remarks

This event fires once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are:

SetCookie Event (AS2Sender Control)

This event is fired for every cookie set by the server.

Syntax

Sub as2sendercontrol_SetCookie(Name As String, Value As String, Expires As String, Domain As String, Path As String, Secure As Boolean)

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (AS2Sender Control)

Fired after the server presents its certificate to the client.

Syntax

Sub as2sendercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLStatus Event (AS2Sender Control)

Fired when secure connection progress messages are available.

Syntax

Sub as2sendercontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AS2Sender Control)

This event is fired when a document starts transferring (after the headers).

Syntax

Sub as2sendercontrol_StartTransfer(Direction As Integer)

Remarks

The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (AS2Sender Control)

This event is fired while a document transfers (delivers document).

Syntax

Sub as2sendercontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (AS2Sender Control)

AS2Sender Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AS2Sender Control)

AS2Sender Errors

SMIME Errors