App Implementation: My Inbox

Prerequisites for the Implementation

Before implementing the app, you must ensure the following:
  1. Make sure that you have at least one workflow in the back-end system(s) that defines the task types to be used for My Inbox. Ensure that all the authorizations required for the workflows are maintained.

  2. Make sure that the required SAP Notes are implemented.

  3. Configure the connections between the Gateway system and your back-end system(s) from which you want to retrieve the work items.
    • If you are implementing the My Inbox app for SAP Business Workflows, for more information, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Configuration and Deployment Information Next navigation step Configuration Guide Next navigation step SAP Gateway Configuration Guide Next navigation step SAP Gateway Configuration Next navigation step Connection Settings for SAP Gateway Hub System Next navigation step Connection Settings: SAP Gateway to SAP Systems End of the navigation path.

    • If you are implementing the My Inbox app for an SAP NetWeaver Business Process Management (BPM) system, you must create a logical port to your BPM system, before installing the Task Gateway service. To integrate BPM, you require SAP NetWeaver 7.31 SP15 or higher. For more information, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Configuration and Deployment Information Next navigation step Configuration Guide Next navigation step SAP Gateway Configuration Guide Next navigation step Configuration Settings for SAP Gateway Supported Scenarios Next navigation step Configuration Settings for OData Channel Scenarios Next navigation step Configuring the Task Gateway Service End of the navigation path.

      Then, create an SAP system alias for your application. For more information, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Configuration and Deployment Information Next navigation step Configuration Guide Next navigation step SAP Gateway Configuration Guide Next navigation step SAP Gateway Configuration Next navigation step Connection Settings for SAP Gateway Hub System Next navigation step Connection Settings: SAP Gateway to SAP Systems Next navigation step Creating the SAP System Alias End of the navigation path.

  4. Activate the Task Gateway Service in Customizing for SAP NetWeaver under Start of the navigation path SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Activate and Maintain Services End of the navigation path.

    For more information to activate the Task Gateway Service, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Configuration and Deployment Information Next navigation step Configuration Guide Next navigation step SAP Gateway Configuration Guide Next navigation step Configuration Settings for SAP Gateway Supported Scenarios Next navigation step Configuration Settings for OData Channel Scenarios Next navigation step Configuring the Task Gateway Service Next navigation step Activating Task Gateway Service End of the navigation path.

  5. Assign the software version to the service in Customizing for SAP NetWeaver under Start of the navigation path SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Assign Data Provider to Data Model End of the navigation path.

    For more information to assing the software version, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Configuration and Deployment Information Next navigation step Configuration Guide Next navigation step SAP Gateway Configuration Guide Next navigation step Configuration Settings for SAP Gateway Supported Scenarios Next navigation step Configuration Settings for OData Channel Scenarios Next navigation step Configuring the Task Gateway Service Next navigation step Assigning a Software Version to Service End of the navigation path.

  6. If you run on SAP NetWeaver lower than 7.4, assign the back-end system aliases for the Task Processing Service (/IWPGW/TASKPROCESSING Version 2) in Customizing for SAP NetWeaver under Start of the navigation path SAP Gateway Next navigation step OData Channel Development with IW_BEP Next navigation step Registration Next navigation step Assign SAP System Aliases to OData Service End of the navigation path .

    For more information, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Development Information Next navigation step Developer's Guide Next navigation step SAP Gateway Developer Guide Next navigation step OData Channel Next navigation step Basic Features Next navigation step Service Life-Cycle Next navigation step Activate and Maintain Services End of the navigation path.

Note Note

Ensure that all application related roles and permission are assigned to the My Inbox user.

System Landscape Requirements

For information about the system requirements, see the S/4HANA UI Technology guide at http://help.sap.com/s4hana_OP_1610Information published on SAP site.

Note Note

The app offers the possibility to upload documents. For security reasons, we strongly recommend that you install an appropriate virus scanner in your front-end system landscape and define sufficiently restrictive scan profiles to prevent the upload of malicious content. For more information on virus scanning and scan profiles for apps, see section Virus Scanning in the SAP S/4HANA UI Technology guide.

Required SAP Notes

For this app, the following SAP Notes must be implemented:

Back-End / Front-End Server

SAP Note

Description

2221151Information published on SAP site

Release Information Note for SAP Fiori My Inbox

Implementation Tasks

The following sections list tasks that have to be performed to implement this app. The tables contain the app-specific data required for these tasks.

You can also find the data required to perform these tasks in the SAP Fiori apps reference library at https://fioriappslibrary.hana.ondemand.com/sap/fix/externalViewer/index.html?appId=F0862Information published on SAP site.

Front-End Server : Activate OData Services

Component

Technical Name

OData Service (Version Number)

/IWPGW/TASKPROCESSING (Version 2)

For more information about activating OData services, see section Front-End Server: Activate OData Services in the SAP S/4HANA UI Technology guide.

For more information, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Configuration and Deployment Information Next navigation step Configuration Guide Next navigation step SAP Gateway Configuration Guide Next navigation step Configuration Settings for SAP Gateway Supported Scenarios Next navigation step Configuration Settings for OData Channel Scenarios Next navigation step Configuring the Task Gateway Service End of the navigation path.

Front-End Server : Activate SAP UI5 Application

Component

Technical Name

SAP UI5 Application

CA_FIORI_INBOX

For more information about how to activate the ICF service, see section Front-End Server: Activate ICF Services of SAPUI5 Application in the SAP S/4HANA UI Technology guide.

Front-End Server : Enable App for Access in SAP Fiori Launchpad

The SAP Fiori launchpad is the entry point to the apps. In the launchpad, the user can see and access those apps that have been assigned by an administrator to the catalog designed for this user's role.

The administrator makes these assignments in the launchpad designer. For more information, see section Setup of Catalogs, Groups, and Roles in the SAP Fiori Launchpad in the SAP S/4HANA UI Technology guide.

SAP delivers technical catalogs for groups of apps as repositories to create your own catalogs in the launchpad designer. Along with these catalogs, more technical content is delivered for each SAP Fiori app. You can find the delivered technical content for each SAP Fiori app in the SAP Fiori apps reference library.

Front-End Server and Back-End Server: Assign OData Service Authorizations to Users

You must assign OData service authorizations for the app to your users.

Note Note

Several authorization default values are connected to the OData service. To ensure that all these default values are assigned to a user, you have to follow the instructions given under the documentation links provided.

Make the assignment on the back-end server and on the front-end server:
  • On the back-end server, you have to assign the OData service authorization to a PFCG role. For more information, see section Back-End Server: Assign OData Service Authorization to Users in the SAP S/4HANA UI Technology guide.

  • On the front-end server, you must assign the OData service authorization to a new or existing role, such as a business role that has been adjusted according to your needs. For more information, see sections Create PFCG Role on Front-End and Assign Launchpad Catalogs and Groups, and Front-End Server: Assign Roles to Users in the SAP S/4HANA UI Technology guide.

OData Service (Version Number)

Back-End Server: Authorization Role (PFCG Role)

Front-End Server: Assignment to Authorization Role

/IWPGW/TASKPROCESSING (Version 2)

You can use the example business catalog or your custom catalog to create the back-end PFCG role.

For example, to approve supplier invoices you can use the business catalog Accounts Payable - Supplier Invoice Processing (SAP_PRC_BC_INVOICER).

Use an existing role or create a new one.

Configuration Tasks

If you want to use the preconfigured All Items tile, section Configuring the SAP Fiori Launchpad is optional, and section Defining the Workflow Scenario is not relevant.

Configuring a Task and Decisions

Enter and define a task and those decision options from your workflow task that you want to display in the My Inbox app.

Note Note

This section is only relevant if you are implementing the My Inbox app for your SAP Business Workflow. If the step type for the workflow task is User Decision, configuring a task and decisions is optional. Follow the steps below if you want to make any of the following configuration settings:
  • Add or hide a decision option

  • Change the label of a decision option

  • Define the nature of a decision option (positive or negative)

  • Make comments mandatory for a decision option

To configure a task and decisions, follow the steps below in the back-end system where you maintain your workflow template.

  1. In Customizing for SAP NetWeaver, choose Start of the navigation path Gateway Service Enablement Next navigation step Content Next navigation step Workflow Settings Next navigation step Maintain Task Names and Decision Options End of the navigation path .

  2. Fill in the Step Name table as described below and save your entries:
    • Workflow ID: Enter the ID of your workflow template.

    • Step ID: Enter the task step from your workflow template.

    • Icon MIME Repository Path: Leave this field blank.

    • Step Description: Enter the task name.

  3. Select the entry in the Step Name table and choose Decision Keys in the navigation panel.

  4. Add and define your decision options in the Decision Keys table as described below and save your entries:
    • Key: Enter the decision key.

      Decision keys are numeric and sequential and correspond to the position of decision options in the Workflow Builder. Enter the first decision option with key 1, the second decision option with key 2, and so on.

    • Icon Mime Repository Path: Leave this field blank.

    • Decision Text: Define the label of the decision option.

      This name is displayed on the application screen as a button label. The proposed length of the decision text is maximum 14 characters. Decision texts longer than 14 characters will not fit to the device screen.

    • Comment On: If you want to make it mandatory for the user to add a comment when executing a decision, select this checkbox.

    • Nature: Here you have the following options:
      • Select POSITIVE for the approve type decision option.

        The decision option is displayed either as a green push-button or in a gray popover (depending on the space available) on the detail screen of the application.

      • Select NEGATIVE for the reject type decision option.

        The decision option is displayed either as a red push-button or in a gray popover (depending on the space available) on the detail screen of the application.

      • Leave the field empty for multiple decision options.

        The decision options are displayed either as gray push-button or in a gray popover (depending on the space available) on the detail screen of the application.

        Note Note

        If the step type for the workflow task is not User Decision, implement BAdI /IWWRK/BADI_WF_BEFORE_UPD_IB. For more information, see App Extensibility: My Inbox.

Defining the Workflow Scenario

Define your workflow scenario by completing the following steps in your Gateway system: add a scenario, assign the consumer type, assign roles, and define tasks.

Note Note

This section is only relevant if you want to define and use a scenario-specific tile.

  1. Add a workflow scenario.
    1. In Customizing for SAP NetWeaver, choose Start of the navigation path Gateway Service Enablement Next navigation step Content Next navigation step Task Gateway Service Next navigation step Scenario Definition End of the navigation path .

    2. Choose New Entries.

    3. Fill in the Scenario Decision table as described below and save your entries:
      • Scenario Identifier: Define a scenario ID.

      • Scenario Display Name: Define a name for your scenario.

      • Scenario Order: Not relevant for My Inbox.

      • Technical Service Name: Enter /IWPGW/TASKPROCESSING.

      • Version: Enter 2.

      • EntitySet External Name: Enter Task.

      • Property External Name: Enter TaskDefinitionID.

      • Default Sort by Property: Define how you want to sort the work items on the list screen of the application. If you do not set this parameter, the default value is CreatedOn.

        Note Note

        You can use all the properties of the task collection here.

        To display a list of all the possible properties, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Gateway Next navigation step SAP Gateway 2.0 Next navigation step Content Information Next navigation step Content Guide Next navigation step SAP Gateway Content Guide Next navigation step SAP Gateway Supported OData Channel Scenarios Next navigation step Task Gateway Next navigation step Task Gateway Administrator Next navigation step Task Gateway Service Next navigation step Task Gateway Service Version 2 Next navigation step Task Collection End of the navigation path.

        The property you have selected is added to the list of possible sorting properties on the detail screen of the application.

        Note Note

        You can also define the sorting principles on the UI of the application. You can choose from a list of properties.

      • Mass Action: If you set this parameter to true, you can process, for example, approve or reject, several tasks of the same type at the same time.

      • Class for Scenario Count: Leave it empty.

        Note Note

        If the scenario is not part of the Business Workflow engine or BPM, and you want to see the number of tasks pending for this scenario, enter the name of the class that implements the /IWWRK/IF_TGW_SCENARIO interface in the back-end system.

      • Quick Act.: Select the Quick Act. checkbox to enable quick approval of workflow items by swiping on the screen.

        This field is only relevant if you use a touch screen device.

  2. Assign the consumer type to the scenario.
    1. Select the row containing your approval scenario and choose table Assign Consumer Type to Scenario in the navigation panel.

    2. Choose New Entries.

    3. In the Task Gateway Consumer Type field, select TABLET.

    4. Save your entries.

  3. Assign a role to the consumer type and the scenario (optional).

    Now you can assign an approval scenario to a number of roles, that is, the scenario will only be available to users who are assigned to at least one of the relevant PFCG roles.
    1. Select the row for TABLET (for all devices), and choose Assign Role to Consumer Type and Scenario in the navigation panel.

    2. Choose New Entries.

    3. In the Role column, select the role you want to use.

    4. Save your entries.

  4. Define tasks for your scenario.

    Note Note

    You can define several tasks for your scenario. Make sure that you follow the steps below for each task.

    1. Choose Scenario Definition in the navigation panel, and select the row containing your approval scenario.

    2. Choose Task Definition for Scenario in the navigation panel.

    3. Choose New Entries.

    4. Enter the task type ID for your approval workflow.

      Note Note

      In case of SAP Business Workflow, you can find your task type ID in the back-end system as described below:

      • Start the Workflow Builder.

      • Search for the workflow definition you would like to enable.

      • Open the approval step.

      • Go to Control tab, and check the Task field.

  5. In the SAP System Alias field, enter the source system alias for the task type.

    Note Note

    Make sure that the Task Gateway Service is connected to the selected system aliases.

  6. Save your entries.

Configuring the SAP Fiori Launchpad for the All Items Tile

To configure the All Items tile, perform the following:

  1. Choose the App Launcher - Dynamic tile.

  2. Select the newly created tile, and fill in the following fields as described below:
    • Title: Enter the name of your workflow scenario, for example, Capital Expenditure Approval.

    • Icon: Use any of the available icons.

    • Service URL:

      /sap/opu/odata/IWPGW/TASKPROCESSING;v=2;mo/TaskCollection/$count/?$filter=Status eq 'READY' or Status eq 'RESERVED' or Status eq 'IN_PROGRESS' or Status eq 'EXECUTED'.

    • Semantic Object: Enter WorkflowTask.

    • Action: Enter displayInbox.

    • Parameters: Enter allItems=true&massAction=<true or false>&quickAction=<true or false>&sortBy=<property to be used for sorting>&listSize=<number of items you want to display on your list screen>&showAdditionalAttributes=<true or false>.

      You can define massAction, quickAction, and sortBy, if you want to overwrite your default settings. If you do not define these parameters, the following default values are used:
      • massAction = true

      • quickAction = true

      • sortBy = CreatedOn

      • listSize defines the number of items you want to display on the list screen. The default is 100.

      • showAdditionalAttributes=true; if you want to display custom attributes in the List View.

Configuring the SAP Fiori Launchpad for the Outbox Tile
Ensure that you have the following prerequisites:
  • The SAP NetWeaver Gateway version on your front end server corresponds to SAP NetWeaver Gateway 2.0 SP 11.

  • You have installed SAP IW PGW 100 (IW_PGW 100) SP 08.

To configure the All Items tile, perform the following:
  1. Choose the App Launcher - Dynamic tile.

  2. Select the newly created tile, and fill in the following fields as described below:

    • Title: Enter the name of your workflow scenario, for example, Outbox.

    • Icon: Use any of the available icons.

    • Service URL: Enter /sap/opu/odata/IWPGW/TASKPROCESSING;v=2;mo/TaskCollection/$count/?$filter=Status eq 'FOR_RESUBMISSION' or Status eq 'COMPLETED'.

    • Semantic Object: Enter WorkflowTask.

    • Action: Enter displayInbox.

    • Parameters: Enter allItems=true&outbox=true&listSize=<number of items you want to display>.

      • scenarioID or allItems is mandatory.

      • listSize is optional. The default is 300.

For more information, see SAP Help Portal at http://help.sap.comInformation published on SAP site under Start of the navigation path Technology Platform Next navigation step SAP Fiori Next navigation step For SAP Business Suite Next navigation step Configuration of SAP Fiori Infrastructure Next navigation step Setup of SAP Fiori Launchpad End of the navigation path.
Configuring the Fiori Launchpad for Expert View
Ensure that you have the following prerequisites:
  • You are logged into Fiori launchpad designer in your Fiori front-end server.

  • You have the required role, catalog, semantic object, and action.

To configure the launchpad for expert view:
  1. Create a new tile.

  2. Perform the My Inbox related configurations.

  3. In Parameters, add a parameter expertMode=true.

You can access the newly created tile in the launchpad. On accessing the newly created tile, you can view the expert view.

Configuring the SAP Fiori Launchpad for Scenario-Specific Tiles
To enable My Inbox, create a tile for each workflow scenario as described below.
  1. Choose the App Launcher - Dynamic tile.

  2. Select the newly created tile, and fill in the following fields as described below:

    • Title: Enter the name of your workflow scenario, for example, Capital Expenditure Approval.

    • Icon: Use any of the available icons.

    • Service URL: Enter /sap/opu/odata/IWPGW/TASKPROCESSING;mo;v=2/ScenarioCollection?$filter=key eq '<your scenario identifier>'.

    • Semantic Object: Enter WorkflowTask.

    • Action: Enter displayInbox.

    • Parameters: Enter scenarioId=<ID of your scenario>&listSize=<number of items you want to display on your list screen>>&showAdditionalAttributes=<true or false>.

      where:
      • scenarioID is mandantory.

      • listSize is optional. the default is 100.

      • show AdditionalAttributes = true; if you want to display custom attributes in the List View.

More Information

For general information about the user management concept in a SAP Fiori environment, see Users in ABAP Front-End System and Users in ABAP Back-End System.

Launch My Inbox without Fiori Launchpad

To launch My Inbox directly, without navigating from Fiori launchpad, log on to, https://<server>:<port>/sap/bc/ui5_ui5/ui2/ushell/shells/abap/FioriLaunchpad.html?sap-client=<client>&sap-ushell-url==/sap/bc/ui5_ui5/sap/ca_fiori_inbox&sap-ushell-url=/sap/bc/ui5_ui5/sap/ca_fiori_inbox&<other URL parameters>.

My Inbox supports the following URL properties:

  • allItems= true; to access all tasks for the user.

  • scenarioId= <scenario ID as defined in Task Gateway>; if a specific scenario is configured in task gateway.

  • massAction= true; to enable or disable Mass Action in My Inbox.

  • quickAction= true; to enable or disable quick actions on mobile devices.

  • sortBy= CreatedOn; specify default sort by property. It can have any values from task entity.

  • listSize= <value>; specify a numeric value to limit the number of tasks loaded in the My Inbox.

    You can define massAction, quickAction, and sortBy, if you want to overwrite your default settings. If you do not define these parameters, the following default values are used:

    • massAction = true

    • quickAction = true

    • sortBy = CreatedOn

    • listSize defines the number of items you want to display on the list screen. The default is 100.

    • showAdditionalAttributes = true; if you want to display custom attributes in the List View.

  • scenarioId= scenario ID as defined in Task Gateway; if a specific scenario is configured in task gateway. The massAction and quickAction values will be based on values defined in the Task Gateway.

Example of the URL parameters usage:

https://<server>:<port>/sap/bc/ui5_ui5/ui2/ushell/shells/abap/FioriLaunchpad.html?sap-client=<client>&sap-ushell-config=headerless#Shell-runStandaloneApp?sap-ushell-SAPU_I5.Component=cross.fnd.fiori.inbox&sap-ushell-url=/sap/bc/ui5/sap/ca_fiori_inbox&allItems=true&massAction=false&quickAction=true&listSize=300&sortBy.

Configuring My Inbox to Display Additional Attributes in Master List

  1. Choose the tile configuration for All Items tile or Scenario-Specific tile.

  2. In Parameters, add showAdditionalAttributes = true as value.

    Note Note

    Additionally, you must perform a back-end configuration to create custom attributes with pre-defined names. For more information, see SAP Note 2305330Information published on SAP site.

Integrating a Custom SAPUI5 Fiori Application

Ensure that SAPUI5 Fiori application is on the same front end server.

To configure an intent, perform the following:
  1. Configure target mapping of SAPUI5 application in the Fiori launchpad.

  2. In the Parameters section of target mapping, add the openMode parameter.

    Note Note

    This openMode parameter can have one of the following values:

    • external; the SAPUI5 Fiori app opens externally, when you choose Open Task in the Detail screen.

    • replaceDetails; the application opens in the Detail screen, when you choose Open Task in the Detail screen.

    • embedIntoDetails; the application is displayed in the Detail screen, when you choose task in master list.

    Note: SWFVISU configuration using INTENT_BASED visualization type must be performed at the back-end for a task type. For more information on the back-end configuration, see SAP Note 2305401Information published on SAP site.

    Note Note

    To enable open task action on mobile, specify Phone as a supported device for this target. You can specify this using the Form factor properties in the target mapping configuration.

Specifying Visualization Parameters for Tasks

The supported visualization types inSWFVISU transactions are:

BSP Standard

Standard BSP

ABAP WebDynpro

ABAP WebDynpro

UI5 based on BSP

UI5 based on BSP

INBOX_GEN

My Inbox generic application

INTENT_BASED

Application configured using an intent in Fiori launchpad

For more information, see SAP Note 2200084Information published on SAP site.