Intro

The output management control is a “reusable component”, which means that it can be used as a building block, also for SAP Fiori Elements. The control allows the user to manage the output process of a business document (such as sales orders or billing documents, for example). It gives the user the possibility to evaluate the output history for a specific business document – including the state of an output process – and offers interaction on those.

When triggered by the business application, the output control collects and validates all output parameters, creates the output documents, and outputs them. The possible output parameters handled include what to output, for whom, when, and through which medium.

A simple use case is: You choose to e-mail an output document to your customer based on an available form template. The system records the date the output was created and indicates that the output has been sent.

Output management control - Reusable component
Output management control - Reusable component

Responsiveness and Adaptiveness

The control is based on the smart table and behaves responsively.

Size M - Output management
Size M - Output management
Size S - Output management
Size S - Output management

Layout

Technically, you can use the control in any floorplan or layout type. However, the control is typically is used in object pages or full-screen layouts.

Output management - Object page
Output management - Object page

Components

Smart Table

  • The table title shows the title Output Details (Number of Items). For example: Output Details (4)
  • The table toolbar shows actions as text buttons and the table personalization icon button.
  • The table items display the status and different parameters of the output items:

Status: The status can be In preparation, To be output, Pending, Complete, or Error.

Dispatch Time: The dispatch time can be set to Immediately or Scheduled.

Output Type: For example, a billing document or a sales order.

Channel: Possible channels are printer, email, and XML. The application development team decides which ones are offered. Depending on the channel, the Output Details offer specific information.

Recipient: The recipient can be a business partner or a technical system, for example. If the channel is set to Email, the Output Details popover allows the user to add and edit specific persons to the ToCC, and BCC input fields.

Form Language and Form Template: Shows which language and template is used.

Preview: Is always offered as PDF.

Popover

The Output Details link within the table will open a popover to show more details of the output item. The popover is only be used for the channel Email and Print. It shows the following additional fields which can be changed in edit mode:

Output Management - Depending on the channel the “Output Details” offer specific information.
Output Management - Depending on the channel the “Output Details” offer specific information.
Output Management - Here the channel is
Output Management - Here the channel is "Print"

Footer Toolbar

The footer toolbar offers actions affecting the whole page (for example, the whole billing document). The footer toolbar is be used to provide a global edit which enables editing the output details within the component.  In hte object page, this is located in the object page header toolbar.

Behavior and Interaction

Actions

Table toolbar actions

  • Send Output triggers the output process according to the dispatch time.
  • Resend triggers the output again in case an error occurred. A copy is created for successful documents you wish to output again.
  • Set to Completed generally happens automatically, but you can also manually set the status to complete if the output is obsolete.
  • Show Application Log shows the processing protocol.

Table row actions

  • The PDF icon allows the user to preview the document as a PDF.

Footer toolbar

  • Edit as global edit will be placed in either the footer toolbar or in the object page header toolbar for object pages. There is no partial edit for the output management component available.

Status Dependencies

Actions are enabled or disabled dynamically depending on the status of the output item. The following table explains how the status of output items proceeds and determines the actions that you can perform:

Status of Output Possible Actions
In preparation This is the status after creating an output document until the output process is triggered automatically or manually via the action Send Output. Send Output, Edit
To be output Indicates that the output item is ready to be output. Only visible if the dispatch time is set to Scheduled. If the dispatch time is set to Immediately, the jobs starts to run and the status is not visible to the end user (to short). Editable – Only the dispatch time, Show Application Log
Pending The output has been triggered, but is not yet complete (for example, the output is still in the print queue or the email server didn’t respond yet). Set to Complete, Show Application Log
Error  An error occurred during the output process. Resend, Set to Complete, Show Application Log
Completed  The output item has been fully processed. Resend, Show Application Log

Guidelines

The output management component is not an independent application and therefore needs to be embedded into the floorplan of an application.

Resources

Want to dive deeper? Follow the links below to find out more about related controls, the SAPUI5 implementation, and the visual design.

Elements and Controls

Implementation

No links.