The SEND command is used to send an AS2 receipt.

The following keywords may be supplied on the SEND command or as an entry in a keyword/value list argument.

Syntax:

Command

Keyword

Value

Developer notes

SEND

RECIPIENT

value

Mandatory. The identity that that will receive the receipt. This value is used in resource file lookups.
Value is made up of 2 components separated by a colon, a name component and an optional private keystore password component.
Example: ACME:mypassword

DELIVERY

value

Mandatory. The address for the receipt delivery. This will have been retrieved from the inbound transaction RECEIPTDELIVERY.

RECEIPTMIC

value

Mandatory. MIC of original transaction.

RECEIPTMESSAGEID

value

Mandatory. Original Message-Id.

RECEIPTSUBJECT

value

Mandatory. Original message subject.

RESPONSE

*DEFAULT

Optional. Default. Send receipt.

*ERROR

Send an error receipt.

PROCESSED

value

Optional. Default value is "processed".

MODIFIER

value

Optional. Default value is blank or "error" for response *ERROR.

AS2TO

value

Optional. AS2-To.

AS2FROM

value

Optional. AS2-From.

FROM

value

Optional. From.

SUBJECT

value

Optional. Subject.

TEXT

value

Optional. Text

MESSAGEID

value

Optional. Complete transaction message id. The Message-Id is normally generated.

SIGNED

*YES

Optional. If *YES, then a keystore password is required.
Access to a private key is not mandatory but it will be required if the receipt is to be signed.

*NO

Default.

USER

value

Optional. Basic authentication user.

PASSWORD

value

Optional. Basic authentication password.

The RECIPIENT keyword value is used to obtain the signing key file, password and signing certificate using a selection hierarchy of entries from the properties file.

     keystore.{recipient}= pki/filename
     keystore = pki/filename
     keystore.password.{recipient} = password
     keystore.password = password
     certificate.{recipient} = pki/filename
     certificate = pki/filename
     as2-to.{recipient} = companyto
     as2-from.{recipient} = companyfrom
     as2-from = companyfrom
     from.{recipient} = from
     from = from
     subject.{recipient} = subject
     subject = subject
     messageid.prefix.{recipient} = company identifier
     messageid.prefix. = company identifier
     signed.algorithm.{recipient} = *MD5 | *SHA1 | *SHA256 | *SHA384 | *SHA512
     signed.algorithm = *MD5 | *SHA1 | *SHA256 | *SHA384 | *SHA512

Human readable text is obtained from a file using a properties file selection hierarchy.

     receipt.message.{recipient} = system/receipt-message.txt
     receipt.message = system/receipt-message.txt
     receipt.error.{recipient} = system/receipt-error.txt
     receipt.error = system/receipt-error.txt

The receipt.message contains the human readable component of the receipt.

The receipt.error contains the human readable component of the error receipt.

The following special merge labels are supported in the receipt.message and receipt.error files:

%%COMPANYFROM%%
%%COMPANYTO%%
%%DATE%%
%%SUBJECT%%
%%TEXT%%

Sample receipt.message file content:

The message sent to recipient <%%COMPANYTO%%> on %%DATE%% with subject "%%SUBJECT%%" has been received.

Sample receipt.error file content:

The message sent to recipient <%%COMPANYTO%%> on %%DATE%% with subject "%%SUBJECT%%" contains the following error %%TEXT%%.


  • No labels