Payload Editor

Use

You use Payload Editor to edit data in complex payload structures.

You can call up Payload Editor in the postprocessing order by choosing the processing method Display or Change on the Message Data tab page. Set up the authorizations in Customizing for Cross-Application Components under Start of the navigation path General Application Functions Next navigation step Error and Conflict Handler Authorization for Payload Editor End of the navigation path .

Prerequisites

You have made the settings required for a virus scan during that occurs during the file upload. For more information, see Virus Scan Interface.

Features

Log Area

The log area contains all notifications that exist in additional to the main notification related to the postprocessing order. If only the main notification exists, this is what is displayed. By double-clicking on an individual notification, you will receive more detailed information, if it is available. In the log area, you can display process-specific and notification-specific PPO Hints, if these are available. In addition, you can create a fully specified PPO Hint for a specific message. You always create a new PPO Hint in the current logon language.

Basic Data

Basic data comprises its own area. However, you can specify a comment for each version.

If you want to write a longer text, you can create a note. In the Note for Payload dialog box, you can copy a text from a file into the note as well as save the note text as a file.

Detail Data

The Payload Editor maps the deeply, nested data structure in a hierarchical format. There is a root node under which the components of the structure are displayed.

The following component types exist:

Table
Table line
Structure
Data references: The relevant data areas for the references are grouped under the Data Area for References node and displayed as separate nodes.

The individual fields are displayed only in the detail view. In the detail view of a component, the following functions are available, depending on the component type:

Search: You can search the data and field labels. The user can decide whether to search the entire data structure or only a specified area.
Add Line to Table: You add a new table line to the selected table. You need to confirm the new table lines with Copy Line to Table or discard with Do Not Copy Line to Table before you can continue processing.
Copy a Table Line: You copy the selected table line. You need to confirm or discard the new table line.
Delete Line from Table: You delete the selected table line.
Navigate to the Data Object: You go to the data area of the selected data reference.

Versions

The Payload Editor has versioning so that you can track changes to the payload.

In addition to the actual data (detail data), the system can create metadata (basic data), for example, the date of the last change. If you have changed only the basic data, no new version is created when you save. If you have added an attachment, a comment, or a note, no new version is added when you save.

If you change detail data, a new version is created the first time you save after having called up the Payload Editor. If you save additional changes to the detail data within the same call, this does not lead to the creation of a new version. A new version is created only if you call up Payload Editor again and then make changes to the detail data.

You can create an explicit new version by performing the following actions:

In display mode, choose .

The system creates a new version with the data of the version currently being displayed. This new version is not written to the database until you explicitly save with .
In processing mode, choose the pushbutton.

The data you have just change is saved as the new version. You use this function, for example, if you need to make extensive changes and for this reason do not want to overwrite the current version.

You can only save as a new version, if the current version has already been written to the database.

You can only change the most current version. However, you can change an older version into the newest version by switching to the older version and creating a new version.

Note

The Payload Editor displays the current error messages for a payload. The error messages that are displayed always refer to the newest payload version. In addition to the manual changes in the Payload Editor, each resubmission of the related postprocessing order in Postprocessing Office creates a new payload version if a change from a pre-mapping payload to a post-mapping payload takes place (see Payload). If more than one version of a payload exists, the system always displays the messages of the latest processing, that is of the newest payload version, regardless of which version is being displayed.

Attachments to Payload

In addition to texts, you can also use attachments for documentation or information purposes. Use the Attachment(s) pushbutton to go to the Attachments to Payload dialog box, in which you can add or delete files. When you open the dialog box, existing attachments are displayed. The display also includes attachments that are assigned to other versions or that the have been deleted. The counter on the Attachment(s) pushbutton refers only to the attachments that are assigned to the version currently being displayed

When you upload a file, you can specify your own name for it. The MIME type defines with which program you open the attachment.

You can add or delete attachments only in the latest version. You can delete only attachments that are assigned to the latest version. However, you do not actually delete the file; you delete the link between the version and the file.

To store attachments, ECH uses the standard repository belonging to Enterprise Content Management (ECM). However, you can also use other repositories. For more information, see the documentation for ECM.

You can define that changes to the payload of a postprocessing order can only be saved if specific conditions are fulfilled. For example, that the user has added a note or an attachment. In Customizing for Cross-Application Components under Start of the navigation path General Application Functions Next navigation step Error and Conflict Handler Authorization for the Payload Editor End of the navigation path , the Business Add-In (BAdI) Customer-Specific Check Before Saving in Payload Editor is available for this purpose.