App Implementation: My Inbox

System Landscape Requirements

In order to be able to implement this app, your system landscape has to be enabled for SAP Fiori. Depending on the database type serving as the basis in your system landscape, it has to be set up for SAP Fiori and has to meet the respective prerequisites:

Database	SAP Fiori System Landscape Setup	Prerequisites
ABAP environment	Setup of SAP Fiori System Landscape for SAP Business Suite with ABAP Environment	Installation Requirements (Transactional Apps)
HANA database	Setup of SAP Fiori System Landscape for SAP Business Suite with SAP HANA Database	Installation Requirements (Fact Sheets)

The SAP product version in the back-end system serving as the the basis for the app must be the following:

Required Back-End Product (Product Version Stack)

n/a (n/a)

Each SAP Fiori app consists of front-end components and back-end components:

The front-end components of the app consist of the user interfaces and content required for launching the app on the SAP Fiori launchpad. These components have to be installed on your front-end server.
The back-end components of the app mainly consist of the OData services required for the app. These components have to be installed in your back-end system.

The front-end and back-end components of the app are delivered with the following SAP product versions as part of the listed software components. The required software components for the app are contained in the listed product instances:

App Component	Required SAP Product Version (Support Package Stack)	Available Instances Containing Software Component	Software Component Required for App (Support Package)
Front-End Components	SAP Fiori for request approvals 1.0 ( 06 (01/2016) )	Approve Requests UI NW731 Approve Requests UI NW740 Approve Requests UI 2.0 Approve Requests INT NW740 Approve Requests INT Approve Requests INT NW750	UIX01CA1 100 (6 )
Back-End Components	n/a (n/a)	n/a	IW_PGW 100 (0005 )

For more information about the installation of front-end components, see http://help.sap.com/fiori_implementation.

The app offers the possibility to upload documents. For security reasons, we strongly recommend that you install an appropriate virus scanner in your respective back-end system and define sufficiently restrictive scan profiles to prevent the upload of malicious content. For more information about virus scanning and scan profiles for SAP Fiori apps, see Virus Scanning.

Required SAP Notes

On the back-end server, the following SAP notes must be implemented for this app:

SAP Note Number	Description
2106212	Release Information Note for SAP Fiori My Inbox

On the front-end server, the following SAP notes must be implemented for this app:

SAP Note Number	Description
2106212	Release Information Note for SAP Fiori My Inbox

Implementation Tasks

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

You can 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=F0862

Front-End Server : Activate OData Services

Component	Technical Name
OData Service (Version Number)	/IWPGW/TASKPROCESSING (002 )

For more information about how to activate the OData service, 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 SAP UI5 application (ICF service), see Front-End Server: Activate ICF Services.

Enable App for Access in SAP Fiori Launchpad

To define the access of single users to this app in the SAP Fiori launchpad, technical content is delivered, such as catalogs and example roles.

You can find an overview of the delivered technical content for this SAP Fiori app in the SAP Fiori apps reference library.

For more information about how to procede with this content, see Enable App for Access in SAP Fiori Launchpad.

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

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, a dedicated authorization role (PFCG role) for the OData service is delivered as an example. You can copy this role and adjust it to your needs.
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.

OData Service (Version Number)	Back-End Server: Delivered Authorization Role (PFCG Role)	Front-End Server : Assignment to Authorization Role
/IWPGW/TASKPROCESSING (002 )	In addition, this role contains authorizations to display the related business data. /IWPGW/RT_WF_USR Note In addition, this role contains authorizations to display the related business data.	OData service authorization must be assigned.

OData Service (Version Number)

Back-End Server: Delivered Authorization Role (PFCG Role)

Front-End Server : Assignment to Authorization Role

/IWPGW/TASKPROCESSING (002 )

In addition, this role contains authorizations to display the related business data.

/IWPGW/RT_WF_USR

Note

In addition, this role contains authorizations to display the related business data.

OData service authorization must be assigned.

Prerequisites for Implementation

Before implementing the app, you must ensure the following:

Make sure that you have at least one workflow in the back-end system(s)from which you want to retrieve the work items.
Make sure that the required SAP Notes are implemented.
Configure the connectoins between the Gateway system and your back-end system(s) form which you want to retreive the work items.
- If you are implementing the My Inbox app for SAP Business Workflox, for more informaiton, see SAP Help portal at http://help.sap.comunder Technology SAP Gateway SAP NetWeaver Gateway 2.0 Configuration and Deployment Information Configuration Guide SAP NetWeaver 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 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 BMP, you require SAP NetWeaver 7.31 SP15 or higher. For more information, see SAP Help portal at http://help.sap.comunder 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 under 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 serviceathttp://help.sap.com under 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 source in Customizing for SAP NetWeaverunder 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 serviceat http://help.sap.com under 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 NetWeaverunder Gateway  OData Channel Development with IW_BEP  Registration  Assign SAP System Aliases to OData Service
If you run on SAP NetWeaver lower than 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 under 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

Note

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

Configuration Tasks

To be able to implement the app, you must perform the following configuration tasks in the back-end system:

If you want to use the pre-configured 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 application.

Note

This section is only relevant if you are implementing the My Inbox application 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.

In Customizing for SAP NetWeaver, choose Gateway Serivce Enablement Conent 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
    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

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

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.
    
    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
    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.
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.

Choose Scenario Definition in the navigation panel, and select the row containing your approval scenario.
Choose Task Definition for Scenario in the navigation panel.
Choose New Entries.
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:
1. Start the Workflow Builder.
2. Search for the workflow definition you would like to enable.
3. Open the approval step.
4. Go to Control tab, and check the Task field.
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.
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 Manager Approval (Cross) – Content catalog.
Select the All Items tile and fill in the Parameters field as described below:
- Enter 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'.
- 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 SAP Help Portal at http://help.sap.com--> Tachnology Platform SAP Fiori For SAP Business Suite Configuration of SAP Fiori Infrastructure Setup of SAP Fiori Launchpad .

For more information, see

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.
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-SAPUI5.Component=cross.fnd.fiori.inbox&sap-ushell-url=/sap/bc/ui5_ui5/sap/ca_fiori_inbox&allItems=true&massAction=false&quickAction=true&listSize=300&sortBy.

Specifying Visualization Parameters for Tasks

The supported visualization types in SWFVISU transactions are:

BSP Standard	Standard BSP
ABAP WebDynpro	ABAP WebDynpro
Object Not Represented	Does not display open task action
UI5 based on BSP	UI5 based on BSP
INBOX_GEN	My Inbox generic application

More Information

For more information about app implementation, see http://help.sap.com/fiori_implementation Start of the navigation path App Implementation Information for SAP Fiori End of the navigation path .