My Inbox - UI integration options

vikrant_patil · ‎06-27-2016

Introduction

Most of you must have already heard about or are already using “My Inbox Fiori App”. For the uninitiated here is the brief introduction.

My Inbox Fiori app is a single go to Inbox for dealing with SAP and non-SAP workflows in an enterprise. It follows Fiori design language for user experience. With My Inbox you can,

Make decisions using mobile or desktop devices anywhere and anytime.
You can process your standard and custom workflow tasks from multiple sources.
You can collaborate in a mini forum for each task, share documents through tasks, share tasks by email, JAM and by explicit forwarding.
You can execute tasks in mass.
You can manage substitutes.

My Inbox app consists of front-end component for the user interfaces, Task Gateway for OData services. You can use the app with any SAP or non-SAP back-end component that contains tasks/workflows. SAP delivers connectivity to SAP Business Workflow and SAP NetWeaver Process Orchestration out of the box, for others custom task providers need to be built.

When users are dealing with workflows they need to access information and/or edit/enter data to execute any workflow. Although My Inbox provides workflow contextual data and actions to execute workflow, there are use cases where a user needs tailor made user interface to deal with a workflow. In such cases users would like to access applications associated with workflow from My Inbox. These applications could vary from being legacy to state of the art Fiori application (SAP shipped or custom built)

From above it is clear that there is a need for My Inbox to provide mechanisms to integrate external (to My Inbox) applications. In the remainder of this blog we will look at different integration options available and suitability of each of these options compared to others.

Integration options

My Inbox provides following integration options

Open any application in a new browser tab/window.
Embed any SAP Fiori UI5 application within My Inbox as a default detail screen
Embed any SAP Fiori UI5 application within My Inbox as a navigation link for user to access when he needs to.
Extend My Inbox using extension points/hooks provided by My Inbox

Let’s us examine each of these options in detail to understand suitability of each of these options. (Note: I will not be explaining technical details of how to setup/configure these options in this blog. You can already find these details in official documentation/SAP Notes)

1. Open any task application in a new browser tab/window.

This is the simplest form of integration. It only needs configuration in the back-end. My Inbox gets a URL from the back-end for each task in the Inbox. When user clicks “Open Task” action it launches a new tab/window with corresponding URL. See Image 1 below. (Note: There is no communication between application launched in new tab/window and My Inbox. They work independent of each other)

Image 1.

This option is most suitable for,

Accessing already existing UI applications (legacy). Typically these applications are not responsive in nature for mobile usage and are best suited for desktop access.
Having said that there are no restrictions in accessing SAP UI5 applications or other modern UI technologies also through this mechanism.
Such applications need not be deployed on Fiori Frontend server and can exist where they were deployed already.
Both SAP Business workflow and NetWeaver Process Orchestration support this integration option
Custom task providers can choose to support such integration.
Available since My Inbox 1.0
Accessing legacy applications on mobile devices is not allowed as they most likely are not responsive in nature would be very difficult to work with on a mobile device. However SAP UI5 Fiori applications can be accessed on mobile through this mechanism.

2. Embed any SAP Fiori UI5 application within My Inbox as a default detail screen

This is the most seamless integration option available from end user perspective. Navigation to the embedded app is completely transparent to the end user and happens by default when user selects a task. The detail section of the My Inbox is replaced by the workflow related application. See Image 2 below

Image 2.

User always stays within My Inbox application while working on workflow related applications. This integration can be achieved through configuration in back-end as well as Fiori Front end server (Refer to SAP Note 2305401 - Integration of SAPUI5 Fiori Applications into My Inbox 2.0 for configuration details)

This option is most suitable for,

Integrating SAP Fiori UI5 applications. Typically SAP Fiori UI5 applications are responsive in nature and can be accessed from any device. Such applications are good candidates for embedding in My Inbox as they will provide seamless user interaction.
End users primarily use mobile devices to deal with workflows and need to access workflow applications from mobile devices. If there are no pre-existing SAP Fiori UI5 applications then perhaps you need to plan to custom build either Fiori applications for this purpose.
So far only SAP Business workflow supports this integration option.
Custom task providers can choose to support such integration.
Available since My Inbox 2.0 SP02

3. Embed any SAP Fiori UI5 application within My Inbox as a navigation link for user to access when he needs to.

This integration option also provides seamless user experience as above, but only user has to explicitly choose to navigate to workflow related application. With this integration option the detail section of the My Inbox is replaced by the workflow related application. User can use existing “Open Task” action for the navigation or new action can be added for triggering the navigation. This integration can be achieved through configuration in back-end as well as Fiori Front end server (Refer to SAP Note 2305401 - Integration of SAPUI5 Fiori Applications into My Inbox 2.0 for configuration details). See Image 3 below.

Image 3.

This option is most suitable for,

When user does not always uses workflow application to execute the workflows, but executes directly from My Inbox. But once in a while for some tasks user accesses workflow application to execute workflows. This option like previous should be used to integrate SAP Fiori UI5 applications.
Available since My Inbox 2.0 SP02

4. Extend My Inbox using extension points/hooks provided by My Inbox

This integration option needs custom development and/or configurations to extend My Inbox using the extension points/hooks exposed to add or remove UI elements/functionality to My Inbox. You can find more information at App Extensibility: My Inbox - SAP Fiori for Request Approvals 1.0 - SAP Library and My Inbox Extensibility Cookbook

There are following customizable UI fields in My Inbox. See Image 4 below.

Image 4.

Apart from customizable fields, there are also extensible fields which can be used to enhance My Inbox. See Figure 5 below.

Image 5.

This option is most suitable for,

When you want to add new UI/functionality common for all tasks. You can also add new functionality specific to a task type.
When you want remove/disable certain standard My Inbox features.
Available since My Inbox 1.0

Following images are an example of what you can achieve using above customization and extension options.

Image 6 below is before extending My Inbox.

Image 6.

Image 7 below is after extending My Inbox

Image 7.

nltlo2 · ‎07-06-2016

Hi Vikrant, thanks for the article nice summary and shared on the SAP Business Workflow group on Linkedin ( https://www.linkedin.com/groups/1881723 ).

One question I have is regarding the ability to process Successfactors workflows, do you know if this is possible ? The reverse is possible from the Successfactors workflow inbox you can process SAP Business workflows through the Odata connector : http://image.slidesharecdn.com/hr2015masterslatestenhancementsinsap-150428121041-conversion-gate01/9...

karanbahl · ‎07-07-2016

The note mentioned seems incomplete as the steps mentioned are not able to achieve the desired outcome.

Regards,

Karan

vikrant_patil · ‎07-08-2016

Hi Thierry,

Building standard connectors to Successfactors is in the pipeline already. In the meanwhile a custom connector could be built in Gateway. How to create a custom data provider for Task Gateway

Vikrant

vikrant_patil · ‎07-08-2016

Which of the mentioned options did you try?

karanbahl · ‎07-08-2016

Details can be found here:

Issues in Integration of SAPUI5 Fiori Applications into My Inbox 2.0

nltlo2 · ‎07-11-2016

Thanks for confirming that a standard connectors to Successfactors is in the pipeline. Do you have any information on the release date ( I am aware that this is very difficult to confirm ).

Former Member · ‎12-30-2016

Hii Vikrant,

We are facing issues in implementing the first scenario i.e. Open any task application in a new browser tab/window.

We are trying to open a custom sapui5 application from MyInbox Application , we have done configs in SWFVISU ,but nothing worked ,If possible kindly share any document or link regarding our scenario,

Regards,

Vinayak

former_member290377 · ‎11-22-2017

Hi Vikrant,

As mentioned above,

integration type 2 can only be possible for Business Workflow. Is it possible for BPM task which has UI5 screen? And also is BPM task integration possible as 3rd or 4th type of integration?

former_member182874 · ‎12-08-2017

Helpful 🙂

Former Member · ‎02-16-2018

Thanks for the nice article.

I am wondering How Alerts are deal with MyInbox app ?

Our existing portal has Alert notifications send from BW system. How this can be configured in MyInbox app ?

We are using CRM UWL Item provider notifications using IF_UWL_Item_Provider intreface in the existing Portal.

How the same can be used to send notifications to MyInbox app ?

Thanks

Sam

vikrant_patil · ‎02-22-2018

Hi Sam,

There is provider connector shipped for alerts. However you can custom build a provider for Task Gateway to bring alerts into My Inbox.

Former Member · ‎02-22-2018

Hi vikrant.patil,

Thanks for the reply.

The Notifications I am referring to are Non-Workflow task notifications, like Alerts triggered from ALRTCATDEF and CRM Notifications using IF_UWL_ITEM_PROVIDER interface in a class.

It would be great, if you direct me to any Blog or Note for Provider connector for Alerts and Custom Provider development tips.

Thanks

Sam

ibrahimhassan · ‎10-11-2019

Hello,

Could you please tell me how to add input fields which will be captured and saved either in Workflow container or a table when some one clicks on aprove or reject button?

Thanks

laurent_burtaire · ‎10-11-2019

Hello Mohamed,

this is linked to the embedded Fiori App, not to My Inbox.

Regards.

Laurent

former_member638537 · ‎07-07-2020

Hellovikrant.patil,
Thanks for the blog, I have to show a custom ui5 screen with different drop down actions for the user is this possible ?
Thanks,
Vijay

aqibpathan · ‎08-30-2020

Hi! Vikrant

Thanks for nice blog and is really informative.

We are facing issue with opening GRC workflow. Items shows in the inbox but when clicked nothing happens. Do you have any clue if GRC workflow has any issues with MyInbox integration?

Thanks,

AQIB