IPWorks EDI 2020 macOS Edition

Questions / Feedback?

AS3Sender Module

Properties   Methods   Events   Configuration Settings   Errors  

The AS3Sender component implements an AS3 / EDI-INT client.

Syntax

nsoftware.IPWorksEDI.As3sender

Remarks

The AS3Sender component may be used to send EDI or other messages over FTP/S, using the AS3 protocol. It may also be used to verify Message Disposition Notifications (MDNs) returned by the server.

A typical AS3 transaction is as follows:

(1) The sender sends an EDI document to the receiver using FTP. The document may be signed, encrypted, and/or compressed, and a signed or unsigned receipt may be requested.

(2) The receiver decompresses and 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, AS3From and AS3To, Data, and EDIType. You will also need to specify User, Password, and RemoteHost to Logon to the FTP server. After doing this you may send the data by calling Send.

To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data set SigningCert. To encrypt, set RecipientCerts.

TLS/SSL may be enabled by setting the SSLStartMode property. In case 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 MDN will be returned to the FTP URL specified. The MDNOptions property may be used to customize the request. By default, the class will request a signed MDN over an SHA1 hash.

Validating AS3 MDNs

AS3 MDNs will be returned asynchronously over a separate connection. You may verify MDNs by invoking ReadReceipt. This will read the receipt from the FTP server (or from the MDNReceipt property). It will determine the MessageId of the original message and determine the originator and recipient of the MDN.

You should then look up your trading partner's certificates as well as the OriginalContentMIC (which you must store externally to verify signed receipts), and invoke VerifyReceipt.

Property List


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

AS3FromThe identity of the sending system.
AS3ToThe identity of the receiving system.
AS3VersionThe version of AS3 being used.
AttachmentsCollection of files attached to the current message.
CompressionFormatThe compression format (if any) to use.
ConnectedShows whether the component is connected.
EDIDataThe EDI or other data to be sent.
EncryptionAlgorithmThe algorithm used to encrypt the EDI data.
FirewallA set of properties related to firewall access.
FTPCommandAn FTP command to be sent directly to the FTP server.
FTPLastReplyThe last reply from the FTP server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LogDirectoryThe path to a directory for logging.
LogFileThe log file written.
MDNOptionsUsed to indicate the options requested for the MDN receipt.
MDNReceiptThe MDN receipt returned from the server.
MDNToThe system to which an MDN should be directed.
MessageIdThe Id of the message.
OriginalContentMICThe Message Integrity Check(s) (one-way hash) of the outgoing message.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password to log in.
ReceiptSignerCertEncodedThe certificate (PEM/base64 encoded).
ReceiptSignerCertStoreThe name of the certificate store for the client certificate.
ReceiptSignerCertStorePasswordIf 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.
ReceiptSignerCertStoreTypeThe type of certificate store for this certificate.
ReceiptSignerCertSubjectThe subject of the certificate used for client authentication.
RecipientCertCountThe number of records in the RecipientCert arrays.
RecipientCertEncodedThe certificate (PEM/base64 encoded).
RecipientCertStoreThe name of the certificate store for the client certificate.
RecipientCertStorePasswordIf 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.
RecipientCertStoreTypeThe type of certificate store for this certificate.
RecipientCertSubjectThe subject of the certificate used for client authentication.
RemoteHostThe domain name or IP address of the FTP server.
RemotePathThe current path in the FTP server.
RemotePortThe port for the FTP service (default is 21).
SignatureAlgorithmSignature algorithm to be used in outgoing messages.
SigningCertEncodedThe certificate (PEM/base64 encoded).
SigningCertStoreThe name of the certificate store for the client certificate.
SigningCertStorePasswordIf 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.
SigningCertStoreTypeThe type of certificate store for this certificate.
SigningCertSubjectThe subject of the certificate used for client authentication.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
SSLStartModeDetermines how the component starts the SSL negotiation. By default, SSL will not be used.
SubjectThe subject of the message.
TimeoutA timeout for the component.
UserThe user identifier to use for login.

Method List


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

AbortAbort Current Upload/Download.
ConfigSets or retrieves a configuration setting.
DeleteFileRemove a file specified by FileName from an FTP server.
GetFileSizeGets the size of a file on the FTP server.
GetFileTimeGets the last modification time of a file on the FTP server.
ListDirectoryList the current directory on an FTP server.
ListDirectoryLongList the current directory on an FTP server.
LogoffLogoff from the FTP server by posting a QUIT command.
LogonLogon to the FTP RemoteHost using the current User and Password .
ReadReceiptReads and parses (but does not verify) an MDN receipt.
ResetResets the state of the control.
SendPrepares and sends the AS3 message.
VerifyReceiptVerifies an MDN receipt.

Event List


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

ConnectionStatusFired to indicate changes in connection state.
DirListFired when a directory entry is received.
EndTransferFired when a file completes downloading/uploading.
ErrorInformation about errors during data delivery.
LogFired with log information while processing a message.
PITrailTraces the commands sent to the server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a file starts downloading/uploading.
TransferFired during file download/upload.

Configuration Settings


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

CalculateProcessingPercentDoneWhether to show the progress of file processing.
LogFilenameThe base name of the log file.
LogonAfterProcessingWhether to prepare the file before connecting to the FTP server.
ActiveModeIPAllows the specification of the IP address that the server will connect to for active mode connections.
ActiveModePORTAddressAllows the specification of the PORT address value for active mode connections.
AppendToLocalFileAppend downloaded files to a local file.
ApplyFileMaskLocallyWhether to filter the directory listing locally or on the server.
AutoSelectDataIPAutomatically select the data connection IP.
CalculatePercentDoneEnables or Disables calculating the percent complete for downloads.
CheckTotalEntryWhether to ignore directory listing total lines.
DILingerWhen set to True, DI connections are terminated gracefully.
DILingerTimeTime in seconds to have the DI connection linger.
FileTimeFormatThe format of file time reported by the server.
IgnoreEntriesDirectory entry data to ignore.
MaskSensitiveMasks passwords in logs.
ModeZCompressionLevelUsed to specify the level of compression used.
PortRangeAllows the specification of a port range where the component listens for active mode connections.
PreserveFileTimeAttempts to preserve timestamps when transferring files.
RealTimeUploadEnables real time uploading.
RealTimeUploadAgeLimitThe age limit in seconds when using RealTimeUpload.
ReusePISSLSessionInDIWhether the PI SSL session will be reused for the DI connection.
ReuseSSLSessionInDIWhether the SSL session will be reused for the DI connection.
UseClearChannelAllows for the Clear Command Channel (CCC) command.
UseClearDataChannelAllows for the PROT C command.
UseEPSVAllows extended passive mode.
UseMLSDUses listings for machine processing.
UseMLSTUses single file listing for machine processing.
UseModeZAllows compression to be used when transferring data.
UseOldAUTHSSLAllows use of the 'AUTH SSL' command instead of 'AUTH TLS'.
UseProtWhenImplicitSends the PROT P command to the server.
UseRemoteHostAddressForPassiveInstructs the component to use the address specified by RemoteHost when establishing a data connection.
VirtualHostNameSends the HOST command to the server.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 macOS Edition - Version 20.0 [Build 8203]