Fiori DocManager - SAP Fiori Launchpad Plugin

1 min

Deployment Guide for DocManager Fiori plugin (v3.0)


Topic	Description
Plugin Features
Required Back-End Product	SAP S/4HANA FPS 2021 and above S4 CORE 106 or above (for draft mode support)
Required Back-End ECM Components	SAP Transport (ECM) add-on
Minimum UI5 Version Requirements	SAP UI5 1.114.11
Description	Attachments are an integral part of business applications and processes. In SAP S/4HANA, the DocManager Fiori plugin is offered as a central unified solution for uploading attachments across applications. The applications can integrate operations such as upload, download, delete and access to virtual links. The Link Enterprise DocManager Fiori plugin is a reusable component that can be integrated to any standard SAP Fiori Object based app e.g. Purchase Order based application to enable attachment capabilities in SAP S/4HANA.
Implementation Information - SAP Transports	Contact Account Manager or VersaFile point of contact.
Implementation Information - Installation & Configuration	The app consists of front-end components (such as the user interfaces) and back-end components (such as the OData service). The back-end and front-end components are delivered as SAP transports and have to be installed in a system landscape that is enabled for SAP Fiori. Front-End Components • SAP BSP Application - /DFLOW/FIODOCMAN • ICF Path - /sap/bc/ui5_ui5/dflow/fiodocman • UI5 Component - dflow.fiori.plugin.docmanager.Component • Package - /DFLOW/Link Enterprise_FIO_DOCMANAGER Back-End Components (ABAP) • OData Service – External Service Name – /DFLOW/FIORI_DOCMANAGER_SRV Technical Service Name - /DFLOW/FIORI_DOCMANAGER_SRV_0001 Version – 0001 Package – /DFLOW/Link Enterprise_FIO_DOCMANAGER • Plugin Definition – Navigate to transaction - /UI2/FLP_CONF_DEF to define properties for your plugin as shown in screenshot below. (taken care by transports so more of validation) Properties: Below property definitions explained are key to the overall functioning of the plugin component. (These entries are delivered with package. Please consult your product support contact for any questions.) • BADGE_MAX_VALUE = badgeMaxValue - The maximum number to display in the buttons' badge. If the number of attachments is greater than the maximum number, the maximum number followed by a plus sign will be displayed. • DISPLAY_BADGE = displayBadge - Controls whether or not to display a badge next to the plugin button with the number of attachments. • DISPLAY_TYPE = displayType - Is linked to the appearance or user experience of the plugin which basically is defaulted to ‘Dialog’ but alternatively ‘Popover’ is supported too. • DRAFT_ENABLED = draftEnabled - This property is used to control the availability of draft feature in general. Enabling/Activating the Plugin (Customizing): /UI2/FLP_CUS_CONF → To make your plugin available in specific clients Property Values: Providing values to the property defined is performed in this transaction. These values govern the app behavior and shouldn’t be changed without consulting product support. Values are case-sensitive too. • UI Adaptation The DocManager plugin was developed to replace SAP’s standard Attachment Services UI, addressing its limitations and offering additional functionality. To prevent users from seeing the default “Attachments” tab in Fiori apps, use the Key User Adaptation approach to hide the standard “Attachment” feature wherever DocManager is enabled. Our solutions team will help adapting apps during implementation but for further details please refer to standard SAP guide here to learn more about pre-requisites and approach. • Plugin Activation Control: In addition to the core ECM configurations in order for the Fiori plugin to work we also deliver an configuration cluster /DFLOW/FDMCFG that can be accessed via T-Code /DFLOW/SYS -> Menu Path -> Configure -> “Attachment Services” -> “Fiori Options” to control the plugin activation per any standard or customer Fiori apps and along with other additional technical details. Our solutions team works with customers to identify potential SAP Business Processes to be enabled and accordingly help populate required information based on your SAP S/4HANA version. Below is a sample entry for activating DocManager plugin for Business Partner app.
Validation Checklist	Validate Customers S/4HANA and Fiori Versions for compatibility and support. Import DocManager related transports into development environment. Activate (if needed) SICF services for oData and Plugin. Validate entries for Fiori DocManager Plugin definition and activation entries in SAP Fiori Launchpad customizing. Identify and enable plugin to desired SAP Standard Fiori apps. Support customers to complete UI Adaptation on standard SAP Fiori Apps to hide “Attachment” tab. Launch and validate Fiori DocManager plugin on all respective standard Fiori apps.
Technical Considerations – HDM Dependancies	DocManager plugin works in absence of HDM functionality however if HDM is enabled below matrix will help clarify any limitation towards support for draft-mode in Fiori Apps.
Technical Considerations – Standard Fiori Apps	Only limitation with standard Fiori Apps would be with support for Draft-Mode attachment feature as the plugin only supports SAP Standard Fiori Apps that are built using BOPF framework that provides the ability to handle drafts. Learn more here about SAP draft handling concept and dependencies. URLs are well-formed and provide required information like Semantic Object, Action and Object Keys for the plugin to support effectively. Business Objects that are single-valued e.g. Purchase Order number or multi-valued object keys e.g. Purchase Requisition Item must be coded into URL with appropriate key-value pairing e.g. PurchaseRequisition='1000489',PurchaseRequisitionItem='00030', Recommendation - When customers leverage Fiori DocManager plugin, we recommend to hide the standard "Attachments" tab in SAP Fiori Apps to ensure the users are not storing attachments using standard SAP options. "Attachments" tab can be hidden using Fiori "Key User Adaptation" as explained here - click here
Technical Considerations – Custom Fiori Apps	Custom Apps must have a valid Semantic Object and Action associated with it. Custom Apps must be associated to a BOR Business Object (standard or custom) to associate with ArchiveLink document types. Custom Apps built using SAP’s standard guidelines for handling draft will be able to take advantage of draft-mode support in DocManager plugin. (Learn more here about SAP draft handling concept and dependencies). Custom Apps built using non-standard SAP Fiori floorplans need to be reviewed and tested on a case-to-case basis provided other points above meet the requirements.

To conclude, this page is updated from time to time and any discrepancies found please reach out to your customer success contact.