AS2 - Verify Receipt   

Declaration

<AMAS2 ACTIVITY="verify_receipt" AS2RECEIPT="text" RESULTVARIABLE="text" RESULTDATASET="text" ERRORDATASET="text"><CERTIFICATE CERTIFICATEPATH="text" PASSPHRASE="text (encrypted)" TYPE="verify" /></AMAS2>

See Also

AS2 - Create Message, AS2 - Send Message, AS2 - Decode/Verify Message, AS2 - Verify Receipt

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 Properties

Property

Type

Required

Default

Markup

Description

AS2 Receipt File

Text

Yes

(Empty)

AS2RECEIPT=

"c:\temp\20091216014717.as2r"

The location of the receipt file to be created. 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. (More on datasets below under Datasets).

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. (More on datasets below under Datasets).

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.

 

Certificates to Verify Signature Properties

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.

 

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Verify AS2 receipt "C:\AS2\Files\receipt_file.as2r".

 

<AMAS2 ACTIVITY="verify_receipt" AS2RECEIPT="C:\AS2\Files\receipt_file.as2r" RESULTDATASET="ReceiptDataset" ERRORDATASET="ErrorDataset" />

 

↑ Top of Page