|
|
AS2 - Verify receipt |
Declaration
<AMAS2 ACTIVITY="verify_receipt" AS2RECEIPT="text" RESULTVARIABLE="text" RESULTDATASET="text" ERRORDATASET="text"><VERIFY CERTIFICATE="text" PASSPHRASE="text (encrypted)" /></AMAS2>
Description
Verifies an AS2 receipt. AS2 messages may request a Message Disposition Notification [MDN] back if all went well. Upon the receipt of the message and its successful decryption or signature validation (as necessary) a "success" MDN will be sent back to the original sender. If there are any problems receiving or interpreting the original AS2 message, a "failed" MDN may be sent back.
Practical Usage
Used to verify the status of a sent AS2 message. This lets the original sender "know" whether or not the recipient received their message.
Parameters
General
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| AS2 Receipt file |
Text |
Yes | (Empty) | AS2RECEIPT="c:\temp\20091216014717.as2r" | The location of the receipt file to verify. The full path and file name can be entered manually in the provided field or you can click the Folder icon to navigate to the file. |
| Populate variable with result | Text | Yes | (Empty) | RESULTVARIABLE="varName" | The name of the variable in which to populate information about the results. |
| Populate dataset with receipt information | Text | No | (Empty) | RESULTDATASET="AS2Data" | The name of the dataset in which to create and populate with AS2 receipt information. |
| Populate dataset with error information | Text | No | (Empty) | ERRORDATASET="AS2Error" | The name of the dataset in which to create and populate with AS2 error information. |
| Message date | Text | No | (Empty) | MESSAGEDATE="%DateAdd("h",-24,CStr(Now()))%" | If enabled, allows specification of a the date and time (in local time zone) when a message is generated. Otherwise, the value is automatically set to the current date/time when a message is encoded (disabled by default). Click the Custom button to select a pre-customized value. Enable the Expression checkbox to enter your own date/time expression. |
Verify Signature
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Certificate | Text | No | (Empty) | CERTIFICATEPATH="C:\Temp\cert.pfx" | The AS2 certificate public key path used to verify the signature. Multiple certificate/passphrase combinations can be entered. |
| Passphrase | Text | No | (Empty) | PASSPHRASE=AM19YcTl487SZA=aME | The passphrase (password that comprises a whole phrase) associated with the certificate. Multiple certificate/passphrase combinations can be entered. |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This sample task verifies an AS2 receipt.
<AMAS2 ACTIVITY="verify_receipt" AS2RECEIPT="C:\temp\messageReceipt.as2r" RESULTDATASET="Receipt" ERRORDATASET="Error" />