Overview

With ASAPIO Payload Designer (transaction /n/ASADEV/DESIGN), you can define the payload of event messages or batch interfaces using a configuration-only interface, without coding. It also comes with a set of pre-delivered ASAPIO payload types and versions, where a version can also mean a different scope of fields or other settings.

Once you designed the payload using ASAPIO Payload Designer, you can use it in outbound interface definitions.

App modes/screens

1. The Payload Designer main screen allows you to create, copy, or delete Payload Designer Views, and also enables you to create multiple versions for each Payload Designer View.
2. The version screen can be accessed by double-clicking on a specific version on the initial screen. This screen allows you to view and modify the Payload Designer Version.
3. The join builder screen allows you to add or delete tables and join them with other tables.

Payload Designer Main Screen

 

Version Screen

Join Builder Screen

 

Payload Designer actions

There are 5 buttons on the application toolbar:

• Save: Update values.
• Create: Generate a new Payload Designer View.
• Copy: Copy a Payload Designer View including all it’s versions.
• Display/Edit: Change button will toggle the payload designer between display and edit mode.
• Delete: Removes the current payload and all its versions. A confirmation pop-up will appear.

Payload Designer Version actions

The main buttons on the versions screen:

• Search: Search for versions.
• Documentation: Display documentation.
• Create Version: Create specific version for the payload view.
• Delete Version: Delete the selected version.
• Copy Version: Copy the selected version with all joins to a new version.
• Where used version: This will find all the available outbound objects using this version.

 

Create Custom Payload through Payload Designer

Steps to create payload:

• Go to transaction /n/ASADEV/DESIGN
• Click Create Payload Designer Button on main screen and fill in the appropriate fields

Note: Once it is done it will create the first version of Payload and navigate to the main screen of it.

Push the join builder button to create the first table joins

• Insert new table or custom view
• Adjust table joins through field connections
• Back to main screen

 

Note: In the Table section of the Payload the parent relationship is automatically predetermined based on the join conditions of join builder.

Note: In the Field section of the Payload the key fields are automatically predetermined based on hierarchical sorting.

 

Add additional payload fields from master tables:

• Double click on the preferred table
• Select one or multiple fields
• Fields can be resorted though sequence number

 

Outbound configuration using the Payload Designer

Create Outbound Object configuration

• Transaction: SPRO
• Go to IMG > ASAPIO Cloud Integrator – Connection and Replication Object Customizing
• Or go directly to transaction: /ASADEV/68000202
• Select the created Connection
• Go to section Outbound Objects
• Add New Entry and specify:
  • Object: name of the outbound configuration
  • Extraction Func. Module: /ASADEV/ACI_GEN_PDVIEW_EXTRACT
  • Load Type: Incremental Load
  • Trace: activate for testing purposes
  • Formatting Func.: /ASADEV/ACI_GEN_PDVIEW_FORMAT
  • Field Payload View Name: Payload Name
  • Field Payload View Version: Payload Version

Set up ‘Business Object Event Linkage’

Link the configuration of the outbound object to a Business Object event:

• Transaction: SWE2
• Add New Entry and specify:
• Object Category: BO BOR Object Type
• Object Type: Business Object Type sending the event
• Event: the event to react to
• Receiver Type: the message type of the outbound object (this is the link to the Addon configuration)
• Receiver Call: Function Module
• Receiver Function Module: /ASADEV/ACI_EVENTS_TRIGGER
• Linkage Activated: tick the checkbox

Set-up target endpoint in ‘Header Attributes’

Configure the topic / queue / event hub name to send the events to:

• Go to section Header Attributes
• Add New Entry and specify:
• Header Attribute: name of the attribute according to your connector
• Header Attribute Value: value of the attributeaccording to your connector