Intro

The output 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). It gives the user the possibility to evaluate the output history for a specific business document – including the state of an output process – and interact with it.

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 email 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 control - Reusable component

Output control - Reusable component

Responsiveness

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 used in object pages or full-screen layouts.

Output control- Object page

Output control- Object page

Components

Smart Table

Log: Shows the processing protocol.

Status: The status can be In preparation, To be output, Pending, Completed, 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.

Role: Shows the receiver role.

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 To, CC, and BCC input fields.

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

Form Language and Form Template: Show which language and template are used.

Changed On: Shows the date and time the output item was changed.

Form Country/Region: Show the country/region selected for the specific form template.

Attachments: Show the attachments available for the output.

Display: Is always available as a 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 used for the channels Email and Print. It shows the following additional fields that 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"

Dialog

By selecting the number in the Attachments column, a dialog opens that lets you select the available attachments for the output. You can specify whether the attachment should be merged with the form template, or if it should be an additional attachment for the output.
You can merge PDF attachments along with the rendered form into a single PDF document if the print queue format is PDF. You can merge and unmerge attachments for original output items but not for duplicates. You can’t unmerge the PDF or move attachments out of the “Merge with Form Template” section once the output has been triggered.

Output Management - Dialog

Output Management - Dialog

The footer toolbar offers actions affecting the whole page (for example, the whole billing document). A global edit allows you to change the output details within the component. In the object page, this function is located in the object page header toolbar.

Behavior and Interaction

Actions

Table toolbar actions

Table row actions

Footer toolbar

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:

<div> <div>Status of Output</div> <div></div> <div>Possible Actions</div> </div> <div> <div>In preparation</div> <div>This is the status after creating an output document until the output process is triggered automatically or manually via the action <em>Send Output</em>.</div> <div>Send Output, Edit</div> </div> <div> <div>To be output</div> <div>Indicates that the output item is ready to be output. Only visible if the dispatch time is set to <em>Scheduled</em>. If the dispatch time is set to <em>Immediately</em>, the jobs starts to run and the status is not visible to the end user.</div> <div>Editable – Only the dispatch time, Show Application Log</div> </div> <div> <div>Error</div> <div>An error occurred during the output process.</div> <div>Resend, Set to Completed, Show Log</div> </div> <div> <div>Completed</div> <div>The output item has been fully processed.</div> <div>Resend, Show Log</div> </div>

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

Visual Design

  • No links.

Elements and Controls

Elements and Controls

No links.

Visual Design

  • No links.