5
App Implementation: Approve Requests Required SAP Notes For Approve Requests, the following SAP notes must be installed: Back-End/Front-End Server SAP Note Number Description Release information note 1931160 Release Information Note for SAP Fiori Approve Requests Back-end server 1930690 TGW Comment’s CreatedByDetails not working in $expand Back-end server 1929308 TGW Possible Agent’s FullName is missing in $expand Back-end server 1921495 TGW: File name missing in $expand for attachments Back-end server 1914864 Filtering by Status and Priority not working in $expand Technical Data The following tables list technical objects specific for Approve Requests. Back-End Components OData Service Authorization Role (PFCG Role) Task Gateway Service 1.0 (/IWPGW/TASKPROCESSING) No special role required For more information about authorization roles and assigned OData services, see Roles, Users, and Authorizations on Back-End Server [external document]. Front-End Server: UI5 Application Component Technical Name UI5 Add-On UIX01CA1 For more information about how to activate the UI5 application (ICF service), see Activate ICF Services [external document]. Front-End Server: SAP Fiori Launchpad Components Component Technical Name Technical Role SAP_FND_TCR_T_X1 Technical Catalog SAP_FND_TC_T_X1 For more information about roles, catalogs and catalog groups in the SAP Fiori Launchpad, see Setup of Catalogs, Groups, and Roles in the Fiori Launchpad [external document]. Prerequisites for Configuration Before implementing the Approve Requests application for your SAP Business Workflow, you must ensure the following:

Approve Requests Implementation

Embed Size (px)

DESCRIPTION

Approve Requests Implementation

Citation preview

Page 1: Approve Requests Implementation

App Implementation: Approve Requests

Required SAP Notes

For Approve Requests, the following SAP notes must be installed:

Back-End/Front-End Server SAP Note Number Description

Release information note 1931160 Release Information Note for SAP Fiori Approve Requests

Back-end server 1930690 TGW Comment’s CreatedByDetails not working in $expand

Back-end server 1929308 TGW Possible Agent’s FullName is missing in $expand

Back-end server 1921495 TGW: File name missing in $expand for attachments

Back-end server 1914864 Filtering by Status and Priority not working in $expand

Technical Data

The following tables list technical objects specific for Approve Requests.

Back-End Components

OData Service Authorization Role (PFCG Role)

Task Gateway Service 1.0 (/IWPGW/TASKPROCESSING) No special role required

For more information about authorization roles and assigned OData services, see Roles, Users, and

Authorizations on Back-End Server [external document].

Front-End Server: UI5 Application

Component Technical Name

UI5 Add-On UIX01CA1

For more information about how to activate the UI5 application (ICF service), see Activate ICF Services

[external document].

Front-End Server: SAP Fiori Launchpad Components

Component Technical Name

Technical Role SAP_FND_TCR_T_X1

Technical Catalog SAP_FND_TC_T_X1

For more information about roles, catalogs and catalog groups in the SAP Fiori Launchpad, see Setup of

Catalogs, Groups, and Roles in the Fiori Launchpad [external document].

Prerequisites for Configuration

Before implementing the Approve Requests application for your SAP Business Workflow, you must

ensure the following:

Page 2: Approve Requests Implementation

1. Make sure that you have at least one business workflow in the back-end system(s) that defines the

task types to be used for Approve Requests. Ensure that all the authorizations required for the

workflows are maintained.

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

3. Ensure that you have activated the Task Gateway Service and the UI5 service.

For more information, see SAP Help Portal at http://help.sap.com SAP NetWeaver SAP

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

4. Check that you have assigned and configured the connections between the Task Gateway Service

(/IWPGW/TASKPROCESSING) and your back-end system(s) from which you want to retrieve the work

items.

For more information, see SAP Help Portal at http://help.sap.com SAP NetWeaver SAP

NetWeaver Gateway Development Information Developer’s Guide SAP NetWeaver Gateway Developer Guide

OData Channel Basic Features Service Life-Cycle Activate and Maintain Services .

Configuration

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 Approve Requests application.

Follow the steps below in the back-end system where you maintain your workflow template.

1. In Customizing for SAP NetWeaver, choose Gateway Service Enablement Content Workflow Settings

Maintain Task Names and Decision Options .

2. Fill in the Step Name table as described below and save your entries:

■ Workflow ID: Enter the ID of your workflow template, for example, WS30000015.

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

■ Icon MIME Repository Path: Leave this field blank.

■ Step Description: Enter the task name.

This name appears as the heading of the detail screen in the Approve Requests application.

NOTE

This step is only relevant if you are implementing the Approve Requests application for your

SAP Business Workflow.

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.

Page 3: Approve Requests Implementation

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 name 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 as a green pushbutton on the detail screen of the

application.

● Select NEGATIVE for the reject type decision option.

The decision option is displayed as a red pushbutton on the detail screen of the application.

● Leave the field empty for multiple decision options.

The decision options are displayed in a gray drop-down list on the detail screen of the

application.

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.

1. 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 Approve Requests.

■ Technical Service Name: Enter /IWPGW/TASKPROCESSING.

■ Version: Enter 1.

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

Page 4: Approve Requests Implementation

NOTE

You can use all the properties of the task collection here, but we recommend to use

the CreatedOn property.

To display a list of all the possible properties, see SAP Help Portal at http://

help.sap.com SAP NetWeaver SAP NetWeaver Gateway Content Information Content

Guide SAP NetWeaver Gateway Content Guide SAP NetWeaver Gateway Supported Odata

Channel Scenarios Task Gateway Task Gateway Service Task Gateway Service Version 1 Task

Collection .

■ Mass Action: Not relevant for Approve Requests.

■ Class for Scenario Count: If the scenario is not part of the Business Workflow engine, 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.

■ Quick Act.: Select the Quick Act. checkbox to enable quick approval of workflow items.

This field is only relevant if you are using a mobile 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

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

each of your 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.

Page 5: Approve Requests Implementation

NOTE

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.

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.

6. Save your entries.

Configuring the SAP Fiori Launchpad

To enable Approve Requests, you have to create a tile for each workflow scenario as described below.

NOTE

Make sure that role SAP_FND_TCR_T_X1 is assigned to your user.

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

2. Select the Approve Request (SAP_FND_TC_T_X1) catalog.

3. Add a new tile.

4. Choose the App Launcher - Dynamic tile.

5. 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 the default sap-icon://complete.

■ Service URL: Enter /sap/opu/odata/IWPGW/TASKPROCESSING;mo/ScenarioCollection?

$filter=key eq '<your scenario identifier>'.

■ Semantic Object: Enter WorkflowTask.

■ Action: Enter approveRequests.

■ Parameters: Enter scenarioId=<your scenario identifier>.

6. Choose Save.

For more information, see Setup of SAP Fiori Launchpad [external document].

More Information

For general information about how to implement SAP Fiori apps, see System Landscape [external

document].