ReceiveMessage
Task to process incoming AS3 messages and generate MDN receipts
Task version: 1.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Task Parameters
RemoteMessagePath : String
Path to the AS3 message file on the FTP server to be retrieved and processed.
Default: -
Example: /incoming/message.as3
RemoteMdnPath : String
Path to the directory on the FTP server where the generated MDN receipt will be stored.
Defaults to the FTP root directory.
Default: /
Example: /mdn
FtpHost : String
FTP server host name or IP address for the AS3 connection.
Default: -
Example: ftp.example.com
FtpPort : Int32
FTP server port.
Default: 21
Example: 21
FtpUser : String
Username for FTP authentication.
Default: -
Example: myFtpUser
🗝FtpPassword : String
Password for FTP authentication.
Default: -
Example: myFtpPassword123
UsePassiveFtp : Boolean
Defines whether to use Passive mode for the FTP data connection.
Default: True
Example: true
RequireEncrypted : Boolean
If true, the incoming AS3 message is expected to be encrypted and the receiver's own certificate will be used to decrypt it.
Default: -
Example: true
RequireSigned : Boolean
If true, the incoming AS3 message is expected to be signed and the partner's certificate will be used to verify the signature.
Default: -
Example: true
OwnCertificatePath : String
Path to the receiver's private key certificate (.pfx), used to decrypt incoming AS3 messages and sign outgoing MDN receipts.
Default: -
Example: C:\Document\own_cert.pfx
🗝OwnCertificatePassword : String
Password for the receiver's own private key certificate used for decryption and signing outgoing MDN receipts.
Default: -
Example: mySecurePassword123
PartnerCertificatePath : String
Path to the trading partner's public certificate file in .pem format, used to verify the signature of the incoming AS3 message.
Default: -
Example: C:\Document\partner_cert.pem
DeleteMessageAfterProcessing : Boolean
If true, the original AS3 message file will be deleted from the FTP server after successful processing.
Default: False
Example: false
LogDirectory : String
Directory path where AS3 communication logs will be stored. Leave empty to disable logging.
The caller is responsible for log rotation and cleanup of files in this directory.
Default: -
Example: C:\Logs\AS3
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Indicates if the task completed successfully.
Example: true
MessageId : String
The Message-ID extracted from the processed AS3 message, identifying the message sent by the trading partner.
Example: 123456789@ftp.example.com
As3From : String
The AS3-From identifier extracted from the processed message, identifying the sender.
Example: PartnerCompany
As3To : String
The AS3-To identifier extracted from the processed message, identifying the receiver.
Example: MyCompany
Payload : String
The decrypted and verified EDI payload extracted from the AS3 message.
Example: ISA00...
MdnRemotePath : String
The full path on the FTP server where the generated MDN receipt was stored.
Example: /mdn/message-mdn.txt
Error : Error
Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }
Error.Message : String
Summary of the error.
Example: Unable to find message.
Error.AdditionalInfo : Exception
Additional information about the error.
Example: object { Exception AdditionalInfo }
Task Changelog
Changelog for Task Frends.As3.ReceiveMessage.
[1.0.0] - 2026-08-06
Added
Initial implementation
Last updated
Was this helpful?

