Explaining the Work Item Visualization in the My Inbox App

Objective

After completing this lesson, you will be able to explain the work item visualization in the My Inbox app

The Annotation-Based UI (Smart UI) of My Inbox

The annotation-based smart UI is deprecated and should not be used for new development.

The smart UI is based on OData annotations and is thus able to display more data related to the underlying business object. It uses the same techniques as used by, for example, the Object Page.

The following steps are necessary to enable the smart UI:

  1. Get an annotated OData service.

  2. Activate smart UI by configuring SWFVMD1 (SWFVISU).

Work Item Visualization in the My Inbox App

There are various different working environments available to SAP users, for example, SAP GUI for Windows or SAP Business Client or SAP Enterprise Portal or SAP Fiori Launchpad. You can use different UI technologies in the individual environment, for example classic Dynpros, people-centric UI, WebDynpro, iViews, and so on. For Business Workflow, this means that a work item may need to be processed with different applications: When using the classic SAP GUI for Windows, you might use a Dynpro-based transaction to process a work item from the Business Workplace. For S/4HANA using Fiori Launchpad as Entry Point is recommended. And therefore you have to configure the task and object visualization.

Besides the usual way of executing a work item (direct execution of the object method, which is defined in the task), you can also define an alternative visualization type. There are irrelevant (old) visualization types (WebDynpro, People Centric UI, iViews) and new ones (Intent-Based Navigation, My Inbox Generic Application, UI5 based on BSP) . Workflow visualization enables you to assign an alternative visualization type and the corresponding parameters to a workflow task or an object type.

A Useful Blog

Here is a useful blog that shows how to configure the application that is opened in My Inbox for a specific task: https://community.sap.com/t5/technology-blogs-by-sap/my-inbox-open-task-swfvisu-configuration/ba-p/13292774

There is the Open Task button in My Inbox if you use desktop PC or laptop PC to invoke the functionality. Using the new types with parameters, the My Inbox creates the appropriate Web application call, for example, to start a Web-Dynpro application or a UI5 Application.

Screenshot of the UI of My Inbox highlighting Open Task button

It opens another window to execute the task.

If there is no configuration in the SWFVMD1 table, SAPGUI for HTML windows is opened in a separate tab.

The URL is generated in the ERP back end: http ://<host>.<domain>:<port>/sap/bc/gui/sap/its/webgui/?~transaction=SWNWIEX&P_WI_ID=000001122380&P_APPL=NOTIF&P_ACTION=EXECUTE&~OKCODE=ONLI&sap-ui-theme=sap_bluecrystal&sap-client=800&sap-language=EN.

Please note that the Open Task button is not available in mobile and tablet devices because SAPGUI for HTML or WebDynpro application which is opened does not fit in mobile and tablet screen size.

By controlling URL generation with SWFVMD1 configuration, you can open existing application via http. It helps for reducing app development workload if you use many different type of workflow scenarios. You can use existing application for transition period until you develop custom Fiori app for a dedicated object.

SWFVMD1 configuration has been used for long time in the Portal UWL and SAP Business Client (NWBC). For example, when you execute a workitem in the Portal UWL, WebDynpro screen comes up for executing an action.

The URL generation logic is in the class CL_SWF_UTL_URL_GENERATE.

You specify the visualization parameters as a view cluster

Activities to specify the visualization parameters for tasks, object types, or object methods in the view cluster

You specify the visualization parameters for tasks, object types, or object methods in the view cluster. This gives you the option of defining the visualization parameters generically for an object method, or separately for a particular task. The visualization parameters for a task override the visualization parameters for a referenced object method.

  1. To specify the visualization parameters, choose ToolsBusiness WorkflowDevelopmentDefinition ToolsWorklist ClientWorkflow Visualization Configuration. Alternatively execute transaction SWFVMD1 (SWFVISU).

  2. In the Task Visualization view, specify the single-step task and choose the Visualization Type, for example Intend based Navigation.

  3. Select the task and in the Visualization Parameters view, define the parameters for this task.

    The choice of parameters varies depending on the visualization type that you select. The following table shows the possible parameters and appropriate parameters of the relevant launcher for the visualization types that are supported in the My Inbox.

    Transaction SWFVISU in ERP:

    Screenshot of the Transaction SWFVISU

    There is a configuration Task ID – Visualization Type.

    Note

    Be aware, that since S/4 On-Premise 2020 customers should maintain visualization settings in the SWFVMD1. In addition, check SAP Note https://launchpad.support.sap.com/#/notes/2896183.

    This table shows a list of the possible Visualization Types. Flagged ones are supported by My Inbox.

    Possible Visualization Types

    Visualization TypeMy InboxSupportedNotes

    BSP BluePrint

      

    BSP Standard

    X

    See: http://service.sap.com/sap/support/notes/2218632 – URL for BSP standard contains //

    Java WebDynpro

      

    ABAP WebDynpro

    X

    See: http://service.sap.com/sap/support/notes/2187457 – Parameter "sap-wd-configId" is not set for ABAP Web Dynpro URL

    iView

     

    Used in Portal UWL

    Portal Component

     

    Used in Portal UWL

    Portal Page

     

    Used in Portal UWL

    Object-Based Navigation

     

    Used in Portal UWL

    Object Not Represented

    X

    Does not display open task action

    UI5 based on BSP

    X

    See: http://service.sap.com/sap/support/notes/2056158 – URL generation for UI5 applications (BSP)

    My Inbox Generic Application

    X

    See: http://service.sap.com/sap/support/notes/2178368 – URL generation for any application (My Inbox)

    Intent-Based Navigation

    X

    See: http://service.sap.com/sap/support/notes/2274940 – URL generation for intent-based navigation

Parameters

A challenge is, that you need to know the parameters to pass a dynamic value.

To define variables and use parameters from SAP Basis, use Transaction SWPA.

Dynamic value

Dynamic Value

ExpressionDescriptionExample

{SYSTEM}

Name of the back-end system (SY-SYSID)

PRD

{CLIENT}

Client (SY-MANDT)

005

{TASK}

Work item task

TS00008267

{WORKITEM}

Work item ID

000006498715

{OBJKEY}

Object key (_WI_OBJECT_ID.INSTID)

4711

{&EXPRESSION&}

Any expression on the work item container

{&_WI_OBJECT_ID.AMOUNT&}

You can find parameter names in the table SWFVVTP.

Also look at the SAP Library: Work Item Visualization in the Universal Worklist (UWL) – SAP Business Workflow: Reference Documentation.

Task

TypeParameterMandatoryExample

BSP Standard

APP_PATH

  

BSP Standard

APPLICATION

  

BSP Standard

CONFIRM

  

BSP Standard

CUSTOMER_NAMESPACE

  

BSP Standard

DYNPARAM

  

BSP Standard

NAMESPACE

  

BSP Standard

PAGE_ID

  

BSP Standard

SYSTEM_ALIAS

  

Task: TS21500003: Approval Process (WebDynpro ABAP)

Task: TS21500003

TypeParameterMandatoryExample

ABAP WebDynpro

APPLICATION

X

HRESS_A_PTARQ_LEAVREQ_APPL

ABAP WebDynpro

NAMESPACE

X

SAP

ABAP WebDynpro

CONFIGURATION

 

HRESS_AC_PTARQ_LEAVREQ

ABAP WebDynpro

CONFIRM

  

ABAP WebDynpro

DYNPARAM

 

LRF_ARQ_MODE=A&LRF_WITEM_ID=${item.externalId}

ABAP WebDynpro

SYSTEM_ALIAS

  

Task: TS########

Task: TS########

TypeParameterMandatoryExample

UI5 based on BSP

APPLICATION

X

 

UI5 based on BSP

DYNPARAM

  

UI5 based on BSP

PAGE_ID

  

Task: TS########: Purchase Order approval

Task: TS########

TypeParameterMandatoryExample

Generic Application

SCHEME

X

sapui5

Generic Application

APPLICATION_PATH

X

/sap/opu/odata/sap

Generic Application

COMPONENT_NAME

X

cross.fnd.fiori.inbox.annotationBasedTaskUI

Generic Application

QUERY_PARAM00

 

data=/sap/opu/odata/sap/CB_PURCHASE_ORDER_SRV;o=sid({SYSTEM}.{CLIENT})/PurchaseOrders(PurchaseOrder='{OBJKEY})’

Generic Application

QUERY_PARAM01

 

annotations=/sap/bc/bsp/sap/bscnbon_anf_mm/bscbn_purchaseorder_anno.xml

Generic Application

QUERY_PARAM##

 

Max number of parameter is 09

For further information about the Visualization Parameter for My Inbox to Approve Leave Requests also see: https://community.sap.com/t5/technology-q-a/visualization-parameter-for-my-inbox-to-approve-leave-requests/qaq-p/11224836.

Task: TS########: Supplier Invoice

Task: TS########: Supplier Invoice

TypeParameterMandatoryExample

Intent-Based

SEMANTIC_OBJECT

X

SupplierInvoice

Intent-Based

ACTION

X

displayAdvanced

Intent-Based

QUERY_PARAM00

 

SupplierInvoice={&_WI_OBJECT_ID.####&}

Intent-Based

QUERY_PARAM01

 

FiscalYear={&_WI_OBJECT_ID.####&}

Intent-Based

QUERY_PARAM##

 

Max number of parameter is 09

openMode parameter

Intent-Based Navigation seems a good option if you develop a custom Fiori app. You can set openMode parameter value (external, replaceDetails, embedIntoDetails) in the target mapping definition.

Note

Some of workflow scenarios are not supported in My Inbox. See:https://me.sap.com/notes/2378748/E

For older SAP_BASIS Version watch out for Notes.

To Specify Visualization Parameters for Objects

  1. Navigate to the Object Visualization view and choose New Entries.

  2. Select the object type, object method, and the visualization type.

    If you do not specify a method, the default method of the object type is used instead. The default method is defined in BOR by a relevant indicator. The default method for most object types is DISPLAY.

  3. Select the line and in the Visualization Parameters view, define the values of the parameters for this visualization type.

Example

A BSP Blue Print application of the People-Centric UI is called from the UWL for all work items that reference the object method BUS1006300.EDIT.

  1. Navigate to the Object Visualization view and chooseNew Entries.

  2. Define the following:

    FieldValue
    Object TypeBOR object type
    Object TypeBUS1006300
    Method NameEDIT
    Visualization TypeBSP Blue Print
  3. Select the line and in the Visualization Parameters view, define the values of the parameters for the visualization type BSP BluePrint, for example:

    FieldValue
    CRM_METHODDEFAULT
    CRM_OTYPEBUSINESS_PARTNER