RECEIVE
The RECEIVE command is used to receive an AS2 transaction.
The following keywords may be supplied on the RECEIVE command or as an entry in a keyword/value list argument.
Syntax:
|
Command
|
Keyword
|
Value
|
Developer notes for Command/Keyword/Value
|
|
RECEIVE
|
RECEIVER
|
value
|
Mandatory. The identity that receives the transaction. 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
|
|
PARTNER
|
value
|
Optional. Authentication partner.
|
|
The RECEIVER keyword value is used to obtain the decryption key file, password, decryption certificate and verify authentication certificate using a selection hierarchy of entries from the properties file.
keystore.{receiver}= pki/filename
keystore = pki/filename
keystore.password.{receiver} = password
keystore.password = password
certificate.{receiver} = pki/filename
certificate = pki/filename
authentication.certificate.{partner}=pki/filename
The following properties come from the received HTTP request.
|
Property
|
Description
|
Values
|
|
*AS2TO
|
AS2-To.
|
|
|
*AS2FROM
|
AS2-From.
|
|
|
*AS2VERSION
|
AS2-Version.
|
|
|
*FROM
|
From.
|
|
|
*DATE
|
Date.
|
|
|
*SUBJECT
|
Subject.
|
|
|
*MESSAGEID
|
Message-Id.
|
|
|
*RECEIPTDELIVERY
|
Receipt-Delivery-Option.
|
The delivery address for an asynchronous receipt.
Blank if synchronous receipt requested.
|
|
*RECEIPTPROTOCOL
|
Receipt-Delivery-Option.
|
If asynchronous receipt is required, this contains the protocol required by the receipt.
HTTP
|
|
value
|
HTTP protocol property.
|
|
|
The following properties come from the received transaction.
|
Property
|
Description
|
Example message values
|
|
*MICMD5
|
Calculated MD5 MIC.
|
|
|
*MICSHA1
|
Calculated SHA1 MIC.
|
|
|
*MICSHA256
|
Calculated SHA256 MIC.
|
|
|
*MICSHA384
|
Calculated SHA384 MIC.
|
|
|
*MICSHA512
|
Calculated SHA512 MIC.
|
|
|
*CONTENT
|
Transaction data content type.
|
*XML or *X12 or *EDIFACT or *RECEIPT or mime type in uppercase.
|
|
*CONTENTTYPE
|
Transaction content type in full.
|
application/xml; name=xxxxxxxxxx
|
|
The following properties come from the received receipt.
Use the GET PROPERTY (*CONTENT) to check if the received transaction is a receipt.
|
Property
|
Description
|
Example message values
|
|
*RECEIPTMESSAGEID
|
Message ID of the original transaction. This can be used to match to the original sent transaction.
|
|
|
*RECEIPTMIC
|
MIC of the original transaction.
|
|
|
*RECEIPTMICALG
|
MIC algorithm.
|
MD5, SHA1
|
|
*RECEIPTDISPOSITIONTYPE
|
Status of the original AS2 transaction.
|
Possible values:
processed
displayed
dispatched
deleted
denied
failed.
|
|
*RECEIPTDISPOSITIONMODIFIER
|
Status of the original AS2 transaction.
|
Possible values:
""
error
warning
superseded
expired
mailbox-terminated.
|
|