Business Integration Solutions documentation

Walkthrough: Sales Return Receipt

About this walkthrough

This walkthrough provides an overview of how to send a return receipt to the customer for the returned item.

Prerequisites

Template Description Default report
NM_SALES.RET.RECP NM Template: Sales Return Receipt Sales - Return Receipt (6646)

Story

This connection uses the following pipeline elements:

  • The Record Change Event triggers on Insert and links to the internal document NM_SALESRETRECPTTRIG, which contains only one field: the No. field from the Return Receipt Header table. When a return order receives, the Record Change Event detects it.
  • The XML Generator activity creates an XML file based on an internal document.
  • The Splitter activity creates one message for each received return order.
  • The XML Minifier activity cleans the message of empty nodes and blocks that are not mandatory.
  • The message passes through the XMLSchemaValidator, which verifies that the XML message respects the internal document structure.
  • The Header Mapper activity adds the headers to the message body, filling in the recipients and email subject.
  • The XML to HTML Translator activity creates an HTML email message based on your branding templates. You can also configure an HTML body manually.
  • The Attachment Generator activity adds attachments to the email message based on standard Microsoft Business Central report functionality.
  • The Email Writer endpoint sends the email.
  • The internal document NM_SALESRETRECPT contains all the information needed to configure the XML Generator activity, the Splitter activity, the Header Mapper activity, and the XML to HTML Translator activity. Adding other fields to this document lets you define a personalized email message.

RR User Event

Task

Setup

  1. Import the NM_SALES.RET.RECP.zip configuration package, or use the BIS template if available.

    RR Import

  2. Add a new email account in Email Accounts, then select SMTP Account to send notifications via the Papercut SMTP server.

    Email Account

  3. On the notification page, edit the EMAILWRITER and add the Account ID created in the previous step. Run the configuration once.

    Settings

Process

  1. Create a sales return order with some details and receive it.
  2. Open notification NM_SALES.RET.RECP and observe that the return receipt header is captured by the Record Change Event activity.
  3. Process the notification.

Result

RR Result

The mail sends to all recipients. Using Papercut, the mail is captured in the demo environment, showing a preview of the HTML mail body and a PDF attachment of the Sales - Return Receipt.

For a brief guide, see Papercut SMTP setup.