App Implementation: My Inbox

System Landscape Requirements

Before you start to implement the app, ensure that your system landscape has been set up to enable SAP Fiori. This also implies that the front-end and back-end components for your app are already available in this system landscape:

SAP Fiori System Landscape Options	Setup of SAP Fiori System Landscape with ABAP Environment Setup of SAP Fiori System Landscape with SAP HANA Database Setup of SAP Fiori System Landscape with SAP HANA XS
Configuration of Front-End Server	Configuration of SAP Fiori Infrastructure
Front-End Components Delivered with (Product Version Stack)	SAP enhancement package 1 for SAP NetWeaver 7.0 SPS 05 SAP enhancement package 1 for SAP NetWeaver 7.3 SPS 01 SAP enhancement package 2 for SAP NetWeaver 7.0 SPS 03 SAP enhancement package 3 for SAP NetWeaver 7.0 SPS 01 SAP NetWeaver 7.0 SPS 18 SAP NetWeaver 7.4 SPS 09 SAP NetWeaver Gateway 2.0 SPS 10
Front-End Components Delivered with (Product Version Stack)	SAP Fiori for Request Approvals 1.0 SPS 05
Back-End Components Delivered with (Product Version Stack)	SAP enhancement package 1 for SAP NetWeaver 7.3 SPS 15 (for BPM support)

Ensure that the front-end component of the app is in place on your front-end server. It is automatically installed with the UI add-on.

Front-End Server: Front-End Component of App (Software Component)

UIX01CA1 100 SP05

Ensure that the following Gateway components are in place on your front-end server.

Front-End Server: Gateway Component

SAP IW PGW 100 (IW_PGW 100) SP 07

If you run your back-end server on SAP NetWeaver lower than 7.4, ensure that the following Gateway component is in place on your back-end server.

Back-End Server: Gateway Component

SAP IW BEP 200 (IW_BEP 200) SP 10

For more information about the installation of SAP Fiori products, see Downloading and Installing Product Versions.

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 SAP Fiori 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 SAP Fiori apps, see Virus Scanning.

End of the note.

Required SAP Notes

You can find the required SAP Notes for the My Inbox app in the Release Information Note for SAP Fiori My Inbox (2106212).

Implementation Tasks

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

Front-End Server: Activate OData Services

Component	Technical Name
OData Service (Version Number)	Task Gateway Service 2.0 (/IWPGW/TASKPROCESSING Version 2)

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

For more information about activating OData services, see Front-End Server: Activate OData Services.

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 Front-End Server: Activate ICF Services of SAPUI5 Application (for transactional apps) or Activate ICF Service of BSP Application (fact sheets).

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

The SAP Fiori launchpad is the entry point to SAP Fiori apps. In the launchpad, the user can see and access those Fiori 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 Setup of Catalogs, Groups, and Roles in the SAP Fiori Launchpad.

SAP delivers technical catalogs for groups of SAP Fiori 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.

Prerequisites for Implementation

Before implementing the My Inbox application, ensure the following:

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.
Make sure that the required SAP Notes are implemented.
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.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Configuration and Deployment Information Configuration Guide SAP NetWeaver Gateway Configuration Guide OData Channel Configuration Connection Settings on the SAP NetWeaver Gateway Hub System Connection Settings: SAP NetWeaver Gateway to SAP Systems .
- 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 SP05 or higher. For more information, see SAP Help Portal at http://help.sap.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Configuration and Deployment Information Configuration Guide SAP NetWeaver Gateway Configuration Guide Configuration Settings for SAP NetWeaver Gateway Supported Scena Configuration Settings for OData Channel Scenarios Configuring the Task Gateway Service .
  Then, create an SAP system alias for your application. For more information, see SAP Help Portal at http://help.sap.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Configuration and Deployment Information Configuration Guide SAP NetWeaver Gateway Configuration Guide OData Channel Configuration Connection Settings on the SAP NetWeaver Gateway Hub System Connection Settings: SAP NetWeaver Gateway to SAP Systems Creating the SAP System Alias for Applications .
Activate the Task Gateway Service in Customizing for SAP NetWeaver under Gateway OData Channel Administration General Settings Activate and Maintain Services .
For more information, see section To activate the service at http://help.sap.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Configuration and Deployment Information Configuration Guide SAP NetWeaver Gateway Configuration Guide Configuration Settings for SAP NetWeaver Gateway Supported Scena Configuration Settings for OData Channel Scenarios Configuring the Task Gateway Service .
Assign the software version to the service in Customizing for SAP NetWeaver under Gateway OData Channel Administration General Settings Assign Data Provider to Data Model activity .
For more information, see section To assign the software version to the service at http://help.sap.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Configuration and Deployment Information Configuration Guide SAP NetWeaver Gateway Configuration Guide Configuration Settings for SAP NetWeaver Gateway Supported Scena Configuration Settings for OData Channel Scenarios Configuring the Task Gateway Service .
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 Gateway OData Channel Development with IW_BEP Registration Assign SAP System Aliases to OData Service .
If you run on SAP NetWeaver 7.4, assign the system aliases for the Task Processing Service in Customizing for SAP NetWeaver under Gateway OData Channel Administration General Settings Assign SAP System Aliases to OData Service .

For more information, see SAP Help Portal at http://help.sap.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Development Information Developers Guide SAP NetWeaver Gateway Developer Guide OData Channel Basic Features Service Life-Cycle Activate and Maintain Services .

Configuration Tasks

If you want to use the pre-configured All Items tile, sections Configuring a Task and Decisions and Configuring the SAP Fiori Launchpad are 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 application.

Note Note

This section is only relevant if you are implementing the My Inbox application for your SAP Business Workflow, and you want to define and use a scenario-specific tile. You do not need to perform the steps below for the All Items tile.

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

End of the note.

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

In Customizing for SAP NetWeaver, choose Gateway Service Enablement Content Workflow Settings Maintain Task Names and Decision Options .
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.
Select the entry in the Step Name table and choose Decision Keys in the navigation panel.
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 pushbutton 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 pushbutton 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 pushbuttons 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.

End of the note.

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. You do not need to perform the steps below for the All Items tile.

End of the note.

Add a workflow scenario.
1. In Customizing for SAP NetWeaver, choose Gateway Service Enablement Content Task Gateway Service Scenario Definition .
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
    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.com Technology SAP Gateway SAP NetWeaver Gateway 2.0 Content Information Content Guide SAP NetWeaver Gateway Content Guide SAP NetWeaver Gateway Supported OData Channel Scenarios Task Gateway Task Gateway Administrator Task Gateway Service Task Gateway Service Version 2 Task Collection .
    
    The property you have selected is added to the list of possible sorting properties on the detail screen of the application.
    
    End of the note.
    
    Note
    You can also define the sorting principles on the UI of the application. You can choose from a list of properties.
    
    End of the note.
  - 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
    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.
    
    End of the note.
  - 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.
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.
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.
Define tasks for your scenario.

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

End of the note.
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
  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.
  End of the note.
5. In the SAP System Alias field, enter the source system alias for the task type.
  
  Note
  Make sure that the Task Gateway Service is connected to the selected system aliases.
  
  End of the note.
6. Save your entries.

Configuring the SAP Fiori Launchpad

Configuring the SAP Fiori Launchpad for the All Items Tile

In your Gateway system, assign the SAP_FND_BCR_MANAGER_T business catalog role to the application users. Add the All Items tile from the Tile Catalog to your Launchpad.

If you want to change the pre-configured All Items tile, you can do so by following the steps below:

In your Gateway system, assign the SAP_FND_BCR_MANAGER_T business catalog role to the application users.
Start the launchpad designer in your NetWeaver Gateway system with the following URL: http://<server>:<port>/sap/bc/ui5_ui5/sap/ARSRVC_UPB_ADMN/main.html.
Select the SAP: Cross - Transactional Apps (SAP_FND_TC_T) catalog.
Select the All Items tile and fill in the Parameters field as described below:
Enter allItems=true&massAction=<true or fales>&quickAction=<true or false>&sortBy=<property to be used for sorting>&listSize=<number of items you want to display on your list screen>
- 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.
Choose Save.

Configuring the SAP Fiori Launchpad for Your Scenario-Specific Tiles

To enable My Inbox, create a tile for each workflow scenario as described below.

In your Gateway system, assign the SAP_FND_BCR_MANAGER_T business catalog role to the application users.
Start the launchpad designer in your NetWeaver Gateway system with the following URL: http://<server>:<port>/sap/bc/ui5_ui5/sap/ARSRVC_UPB_ADMN/main.html.
Select the SAP: Cross - Transactional Apps (SAP_FND_TC_T) catalog.
Add a new tile.
Choose the App Launcher - Dynamic tile.
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>
  where:
  - scenarioID is mandatory.
  - listSize is optional. The default is 100.
Choose Save.
Copy the scenario-specific tile you have just created to the SAP_FND_BC_MANAGER_T business catalog.

For more information, see Setup of SAP Fiori Launchpad.

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.