Framework EDI Reference. Methods and Properties
mailDocument. MapDispositionModifierError

Maps a Framework EDI standard error code to a Message Disposition Notification’s (MDN) disposition modifier extension field.

Syntax:

• <lRetVal> = object.MapDispositionModifierError (<lErrorCode >, < sModifierDesc>, [<lReportAsSeverity>])

Parameters:

• lErrorCode – Framework EDI (FREDI) standard error code.
• sModifierDesc – Disposition modifier extension description.
• lReportAsSeverity – Optional.  Severity of the error that is to be reported in the MDN.  This is the disposition modifier and only the following values are allowed:
• 1 – “Warning”
• 2 – “Error”
• If this parameter has not been specified, or 0, the severity is the same as how FREDI reports it.

Returns

If successful returns 1 otherwise 0 if failed.

Remarks

The Disposition Modifier Extension field exists only in the MDN message in the “Disposition” header.  Example,

Disposition: automatic-action/MDN-sent-automatically;processed/error:some error description 

In the above example, the trailing text “error:some error description” is the disposition modifier and is explained as follows:

• “error” is the disposition modifier and the generated value is dependent on the type of error reported by FREDI, or the passed parameter <lReportAsSeverity>.
• “some error description” is the disposition modifier extension that is specified by <sModifierDesc>.

To remove a mapping, pass an empty string to the <sModifierDesc> parameter.  Example,

lResult = oMailDoc.MapDispositionModifierError(12406, “”, 0)

Example

Dim oEdiDoc As Fredi.ediDocument
Dim oSchemas As Fredi.ediSchemas
Dim oSchema As Fredi.ediSchema
Dim oMailDocument As Fredi.mailDocument
Dim oMDN As Fredi.mailMessage

' Create instance of Framework EDI.
Set oEdiDoc = New Fredi.ediDocument

' Set schemas for expected EDI document in the message.
Set oSchemas = oEdiDoc.GetSchemas
oSchemas.EnableStandardReference = False

' Load schema.
Set oSchema = oEdiDoc.LoadSchema(App.Path & "\ASCX12_850.SEF", Schema_Standard_Exchange_Format)

' Get internet mail document object
Set oMailDocument = oEdiDoc.GetMailDocument

' Map the error 12407 to the modifier extension "Invalid Data Element Time"
oMailDocument.MapDispositionModifierError 12407, "Invalid Data Element Time", 2

' Load EDI document normally.
oMailDocument.Load App.Path & "\SampleMail.TXT"

' Get message disposition notification.
Set oMDN = oMailDocument.GetMDN

' Save MDN.
oMDN.Save App.Path & "\MdnOutput.TXT"

MsgBox "Done"

Samples

• M_MapDispositionModifierError.zip