# task-management-sample-app-sfsf-solutions

**Repository Path**: mirrors_SAP/task-management-sample-app-sfsf-solutions

## Basic Information

- **Project Name**: task-management-sample-app-sfsf-solutions
- **Description**: SAP Business Technology Platform offers a standard way for extending SAP solutions. You can extend SAP SuccessFactors systems without disrupting the performance and the core processes. When building extension applications, you can also benefit from the automation of the integration between the cloud platform and SAP SuccessFactors. This is such one extension application that manage employee onboarding in SAP SuccessFactors system.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-18
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Task Management Sample Application for SAP SuccessFactors Solutions

[![REUSE status](https://api.reuse.software/badge/github.com/SAP/task-management-sample-app-sfsf-solutions)](https://api.reuse.software/info/github.com/SAP/task-management-sample-app-sfsf-solutions)

## Introduction

You can extend the functionality of your SAP SuccessFactors system with an extension application deployed in a subaccount in SAP Business Technology Platform (SAP BTP) and at the same time fully integrated in your SAP SuccessFactors system.

The goal of the **task management sample application for SAP SuccessFactors solutions** is to show some best practices when building SAP SuccessFactors extension applications on SAP BTP. We recommend to use this sample application only as a proof of concept and a starting point for implementing extensions. 

Using this application, you can:
 - Manage different tasks related to human resources (HR), and send them for approval to your colleagues
 - Move the employees in your company from one job title to another.
 - Approve the transfer of employees between positions and departments.
 - Hire new colleagues.

 The following diagram shows the technical components that take part in this scenario. 

![Architecture Diagram](SAP-SuccessFactors-Employee-Onboarding.png)

## Prerequisites

There are several components and authorizations that you and/or your team members need.

**Tools**

* [JDK 8](https://www.oracle.com/java/technologies/javase/8all-relnotes.html) or later versions up to JDK 15
* [Maven 3.0.x](http://maven.apache.org/docs/3.0.5/release-notes.html) or later
* [Cloud Foundry Command Line Interface (cf CLI)](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/4ef907afb1254e8286882a2bdef0edf4.html?q=cf%20CLI)
* [git](https://git-scm.com/download/)
* [Lombok](https://projectlombok.org/setup/overview) - if you use an IDE for compilation

**On SAP BTP side:**

* You have either an [enterprise](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/171511cc425c4e079d0684936486eee6.html) or a [trial](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/046f127f2a614438b616ccfc575fdb16.html) global account in SAP BTP.
* You have an S-user or P-user (if you are using an enterprise global account), and a trial user (if you are using a trial account). See [User and Member Management](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/cc1c676b43904066abb2a4838cbd0c37.html?q=user).
* You are an administrator of the global account where you want to register your SAP SuccessFactors system.
* You have enabled the Cloud Foundry capabilities for your subaccount in SAP BTP.

**On SAP SuccessFactors side:**

* You have a dedicated SAP SuccessFactors company instance.
* For SAP SuccessFactors, First Half 2021 Release, you need a user with permissions to access SAP SuccessFactors Provisioning.
* For SAP SuccessFactors, Second Half 2021 Release or later, you need a user with permissions to access Extension Center in SAP SuccessFactors Admin Center that include the Manage Extensions on SAP BTP permissions.

## Process

### 1. Connect the SAP SuccessFactors system you want to extend with the corresponding global account in SAP BTP

To do that, you must register your SAP SuccessFactors system in your global account in SAP BTP. During this process, an integration token is created and then used by the SAP SuccessFactors system tenant administrator to configure the integration on the SAP SuccessFactors system side.

1. In the SAP BTP cockpit, navigate to your global account, and then choose **System Landscape** > **Systems**.

2. In the **Systems** panel, choose **Register System**.

![In the **Systems** panel, choose **Register System**.](screenshots.png/1-systems-view.png)

3. In the **Register** System dialog box:

    1. Enter a name for the system you want to register.
    
     > Use only printable ASCII characters.
    
   ![Enter a name for the system you want to register.](screenshots.png/2-systems-view.png)

    2. In the **Type** dropdown list, select the system type.
    
   ![In the **Type** dropdown list, select the system type.](screenshots.png/3-systems-view.png)

    3. Choose **Register**.

    > SAP BTP generates an integration token that the tenant administrator of the extended SAP SuccessFactors system uses on the respective SAP SuccessFactors system side when configuring the integration between your SAP SuccessFactors system and the global account in SAP BTP.
    
4. Copy the integration token. You need it for configuring the integration on the extended SAP SuccessFactors system side.

5. Close the dialog box.

   The SAP SuccessFactors system appears in the list of registered systems. Its status is **Pending** because the registration process is not yet completed.
    
6. Configure the integration on the SAP SuccessFactors system side:

	1. In **SAP SuccessFactors Admin Center**, navigate to **Extension Center**.

	>If you do not have permissions to access the Extension Center for the corresponding SAP SuccessFactors system, you need to send the integration token to a user with such permissions who will configure the integration on the SAP SuccessFactors system side.

	2. On the **Extensions on SAP BTP** tab page, navigate to the **Add Integration with SAP BTP** screen area, and paste the integration token in the **Integration Token** input field.

   	![In the **Integration Token** input field, paste the integration token.](screenshots.png/4-systems-view-new.png)

	3. Choose **Add**.

	>The system appears in the integration list in the Multi-Cloud Environment screen area, and the status of the integration is displayed in the Integration Status column. To refresh the status of the process, choose the Check Status icon. Wait for the integration to finish.

11. In the SAP BTP cockpit, check the status of the registration process. To do so, navigate to your global account, and on the **Systems** page, check if the status of the SAP system has changed to **Registered**.

If you are already on the **Systems** page, refresh the page to check if the status has changed.

**Note**: You can register a system only once with the same name per global account.

![Check if the status of the SAP System has changed to **Registered**.](screenshots.png/5-systems-view.png)
    
See [Register an SAP SuccessFactors System in a Global Account in SAP BTP](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/e956ba209f30447cb55140e38c15e345.html). 

### 2. Make the SAP SuccessFactors system accessible in the subaccount in SAP BTP in which you want to build your extension application

You need to configure the entitlements for the subaccount where the **task management sample application for SAP SuccessFactors solutions** will be deployed and assign the *api-access* service plan for the SAP SuccessFactors Extensibility service instance to the system you registered in the previous step.

1. In the SAP BTP cockpit, navigate to your global account.

2. In the navigation area, choose **Entitlements** > **Entity Assignments**.

3. Select your subaccount from the **Select Entities:** drop down menu, and then choose **Go**.

![Select your subaccount from the **Select Entities:** drop down menu.](screenshots.png/6-entitle-sfsf-ext.png)

4. Choose **Configure Entitlements**.

![Select your subaccount, choose **Go**, and then choose **Configure Entitlements**.](screenshots.png/7-entitle-sfsf-ext.png)

5. Choose **Add Service Plans**, and then select the **SAP SuccessFactors Extensibility** service.

![Choose **Add Service Plans**, and then select the **SAP SuccessFactors Extensibility** service.](screenshots.png/8-entitle-sfsf-ext.png)

6. In the **Available Service Plans** area, select the system you have registered. Then, select **api-access** and **sso-configuration** service plans, and choose **Add 2 Service Plans**.

7. Save the changes. 

See [Configure the Entitlements for the Subaccount in SAP BTP](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b01e6255607a42889483115dbd56cc1f.html).

### 3. Configure the Entitlements for the SAP BTP, Cloud Foundry Runtime

1. Make sure you are logged on to SAP BTP cockpit as a Cloud Foundry administrator.

2. In your trial global account, choose **Entitlements** > **Entity Assignments**.

3. If there is no entry for the Cloud Foundry runtime, choose **Configure Entitlements**, and then **Add Service Plans**.

4. In the popup, proceed as follows:

    1. Choose **Cloud Foundry Runtime**.

    2. Under **Available Service Plans**, select the **MEMORY** checkbox.

    3. Choose **Add 1 Service Plan**.

![Choose **Cloud Foundry Runtime**, select the **MEMORY** service plan and then choose **Add 1 Service Plan**.](screenshots.png/10-entitle-cf-runtime.png)

5. On the **Entity Assignments** screen, choose **+** on the **Cloud Foundry Runtime** service row to add at least 1 quota to the subaccount, and then choose **Save**.

### 4. Clone the Task Management Sample Application for SAP SuccessFactors Solutions from GitHub

1. Clone the GitHub repository:

```
git clone https://github.com/SAP/task-management-sample-app-sfsf-solutions
```

2. Configure the details of the SAP SuccessFactors system to which you will connect. To do so, in the root of the project locate the **sap-successfactors-extensibility.json** file and replace the value of the `systemName` parameter with the system name of the system you registered in **Step 1: Connect the SAP SuccessFactors system the corresponding global account in SAP BTP**.

3. In the root of the project locate the **vars.yml** file and replace the values of the following parameters:

  - `ID`. Enter your user in SAP BTP. It is either an S-user, a P-user, or a trial user.

  - `REGION_HOST`. Enter **`eu10.hana.ondemand.com`**. To check the `<region_host>`, go to the SAP BTP cockpit, navigate to the subaccount, go to **Overview** and copy the API endpoint from the **Cloud Foundry** section, and remove the `https://api.cf.`

4. Open a console and navegate to the root folder of the project that is created on you local file system after cloning the GitHub repository.

`cd <root folder of the project>`

5. Build the application. To do so, use the following command:

`mvn clean install`

### 5. Create a Destination Service Instance

To connect the **task management sample application for SAP SuccessFactors solutions** to your SAP SuccessFactors system, you use a destination. For that, you first need to create a Destination service instance using the *lite* service plan. You can do that from [**Cockpit**](#cockpit) or [**Cloud Foundry Command Line Interface (cf CLI)**](#cli):

#### Cockpit

1. In the cockpit, navigate to your subaccount, choose **Services** \> **Service Marketplace**, and on the **Service Marketplace** screen, search for the **Destination** service.

2. From the **Destination** service tile, choose **Create** and follow the steps in the wizard to create the instance.

![From the **Destination** service tile, choose **Create**.](screenshots.png/11-destination-instance.png)

3. On the **Basic Info** step:

    - Make sure to select the **lite** service plan.

    - In the **Runtime Environment** field, choose **`Cloud Foundry`**.

    - In the **Space** field, select the space you are working with.

    - In the **Instance Name** field, enter **`destination`**.

4. On the **Parameters** step, leave the **JSON** field empty.

5. Choose **Create**.

![Fill in the fields and choose **Create**.](screenshots.png/12-destination-instance.png)

#### cf CLI

1. Log on to the cf CLI, using this command:

```
cf login -a https://api.cf.eu10.hana.ondemand.com
```

The string `https://api.cf.eu10.hana.ondemand.com` represents the \<api_endpoint\>. To check it, open the SAP BTP cockpit, navigate to the subaccount, go to **Overview** and copy the API endpoint from the **Cloud Foundry** section.

2. Navigate to your Org by typing in the console the number that corresponds to your Org in the list with Orgs that is displayed after you log on to cf CLI.

3. If you have more than one space, navigate to your space, by typing in the console the number that corresponds to your space in the list with spaces.

>If you have only one space, you will be redirected to it right after you specify your Org.

4. Create the Destination service instance, use this command:

`cf create-service destination lite destination`

### 6. Create an SAP SuccessFactors Extensibility Service Instance to Consume the SAP SuccessFactors APIs

To consume the SAP SuccessFactors APIs, you create an SAP SuccessFactors Extensibility service instance using the *api-access* service plan.

During the service instance creation, an HTTP destination on a subaccount level is automatically generated in this subaccount. You use this destination to establish connection to your SAP SuccessFactors system.

Configure the details of the SAP SuccessFactors system to which you will connect. To do so, in the root of the project locate the `sap-successfactors-extensibility.json` file and replace the following parameter:

 - `systemName`

Enter the system name of the system you registered in [Step 1:](Connect the SAP SuccessFactors system you want to extend with the corresponding global account in SAP BTP). 

You can use [**Cockpit**](#cockpit-1) or [**Cloud Foundry Command Line Interface (cf CLI)**](#cli-1):

#### Cockpit

1. In the cockpit, navigate to your subaccount, choose **Services** \> **Service Marketplace**, and on the **Service Marketplace** screen, search for the **SAP SuccessFactors Extensibility** service.

2. From the **SAP SuccessFactors Extensibility** service tile, choose **Create** and follow the steps in the wizard to create the service instance.

![From the **SAP SuccessFactors Extensibility** service tile, choose **Create**.](screenshots.png/13-sfsf-ext-instance.png)

3. On the **Basic Info** step:

    - Make sure to select the **api-access** service plan.
    
    - In the **Runtime Environment** field, choose **`Cloud Foundry`**.

    - In the **Space** field, select the space you are working with.

    - In the **System Name** field, select your registered SAP SuccessFactors system.

    - In the **Instance Name** field, enter **`sap-successfactors-extensibility`**.
    
![Select the **api-access** service plan and enter **`sap-successfactors-extensibility`** in the **Instance Name** field.](screenshots.png/14-sfsf-ext-instance.png)

4. On the **Parameters** step, the JSON file is preconfigured. Choose **Next.**

![The `sap-successfactors-extensibility.json` file is preconfigured.](screenshots.png/15-sfsf-ext-instance.png)

5. Choose **Create**.

#### cf CLI

1. Log on to the cf CLI, using this command:

```
cf login -a https://api.cf.eu10.hana.ondemand.com
```

The string `https://api.cf.eu10.hana.ondemand.com` is the \<api_endpoint\>. To check it, open the SAP BTP cockpit, navigate to the subaccount, go to **Overview** and copy the API endpoint from the **Cloud Foundry** section.

2. Navigate to your Org by typing in the console the number that corresponds to your Org in the list with Orgs that is displayed after you log on to cf CLI.

3. If you have more than one space, navigate to your space, by typing in the console the number that corresponds to your space in the list with spaces.

>If you have only one space, you will be redirected to it right after you specify your Org.

4. Create the SAP SuccessFactors Extensibility service instance, use this command:

`cf create-service sap-successfactors-extensibility api-access sap-successfactors-extensibility -c sap-successfactors-extensibility.json`
      
### 7. Create a Service Instance of the Authorization and Trust Management (XSUAA) Service

To configure the **task management sample application for SAP SuccessFactors solutions** authentication, you create an Authorization and Trust management service instance with **application** service plan. You can do that from [**Cockpit**](#cockpit-2) or [**Command Line Interface (CLI)**](#cli-2):

#### Cockpit

1. In the cockpit, navigate to your subaccount, choose **Services** \> **Service Marketplace**, and on the **Service Marketplace** screen, search for the **Authorization & Trust Management** service.

2. From the **Authorization & Trust Management** service tile, choose **Create** and follow the steps in the wizard to create the service instance.

![From the **Authorization & Trust Management** service tile, choose **Create**.](screenshots.png/16-xsuaa-instance.png)

3. On the **Basic Info** step:

    - Make sure to select the **application** service plan.
    
    - In the **Runtime Environment** field, choose **`Cloud Foundry`**.
    
    - In the **Space** field, select the space you are working with.

    - In the **Instance Name** field, enter **`xsuaa`**.
    
![Select the **application** service plan and in the **Instance Name** field, enter **`xsuaa`**.](screenshots.png/17-xsuaa-instance.png)

4. On the **Parameters** step, upload the `xsuaa.json` file.

![On the **Parameters** step, upload the `xsuaa.json` file.](screenshots.png/18-xsuaa-instance.png)

5. Choose **Create**.

#### cf CLI

1. Log on to the cf CLI, using this command:

```
cf login -a https://api.cf.eu10.hana.ondemand.com
```

The string `https://api.cf.eu10.hana.ondemand.com` represents the \<api_endpoint\>. To check it, open the SAP BTP cockpit, navigate to the subaccount, go to **Overview** and copy the API endpoint from the **Cloud Foundry** section.

2. Navigate to your Org by typing in the console the number that corresponds to your Org in the list with Orgs that is displayed after you log on to cf CLI.

3. If you have more than one space, navigate to your space, by typing in the console the number that corresponds to your space in the list with spaces.

>If you have only one space, you will be redirected to it right after you specify your Org.

4. Create the Authorization & Trust Management service instance, use this command:

 `cf create-service xsuaa application xsuaa -c xsuaa.json`

### 8. Build and Deploy the Application

You have to use **Cloud Foundry Command Line Interface (cf CLI)** to deploy and run the **task management sample application for SAP SuccessFactors solutions**.

1. Log on to the cf CLI, using this command:

```cf login -a https://api.cf.eu10.hana.ondemand.com
```

The value `https://api.cf.eu10.hana.ondemand.com` represents the \<api_endpoint\>. To check it, go to the SAP BTP cockpit, navigate to the subaccount, go to **Overview** and copy the API endpoint from the **Cloud Foundry** section. See [Log On to the Cloud Foundry Environment Using the Cloud Foundry Command Line Interface](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/7a37d66c2e7d401db4980db0cd74aa6b.html).

2. Navigate to your Org by typing in the console the number that corresponds to your Org in the list with Orgs that is displayed after you log on to cf CLI.

3. If you have more than one space, navigate to your space, by typing in the console the number that corresponds to your space in the list with spaces.

>If you have only one space, you will be redirected to it right after you specify your Org.

4. In the cf CLI push the `vars.yml` file using this command:

`cf push --vars-file vars.yml`

### 9. Configure Single-Sign On Between a Subaccount in SAP BTP and SAP SuccessFactors

To ensure the required security for accessing the applications, you need to configure the single sign-on between the subaccount in SAP BTP and the SAP SuccessFactors system using a SAML identity provider. The single sign-on requires both solutions to be configured as trusted SAML service providers for the identity provider, and at the same time, the identity provider to be configured as trusted identity provider for the two solutions.

#### 9.1. Establish trust between an SAP SuccessFactors system and a subaccount in SAP BTP.

1. Download SAML metadata from the SAP SuccessFactors system.

	1. Go to `https://<sap_successfactors_system>/idp/samlmetadata?company=<company_id>&cert=sha2` where:
		
		- `<sap_successfactors_system>` is the hostname of your SAP SuccessFactors system
		
		- `<company_id>` is the ID of your SAP SuccessFactors company
	
	2. When you are prompted, save the file on your local file system and change its extension to `.xml`.
	
2. Register the SAP SuccessFactors identity provider in the SAP BTP cockpit.

	1. Open the cockpit and navigate to your subaccount.
		
	2. Choose **Security** > **Trust Configuration**.
		
	3. Choose **New Trust Configuration**.
	
	![Navigate to your subaccount, choose **Security** > **Trust Configuration** and then, choose **New Trust Configuration**.](screenshots.png/19-new-trust-config.png)
		
	4. To upload the SAML metadata you downloaded in step 1, choose **Upload**. Browse to the XML file you saved and select it. Some of the fields are automatically filled in.
	![To upload the SAML metadata you downloaded in step 1, choose **Upload**.](screenshots.png/20-new-trust-config.png)
		
	5. In the **Name** field, enter a meaningful name for the trust configuration.
		
	6. Save the changes.
		
3. Make the trust configuration to the SAP SuccessFactors identity provider the only configuration that is available for user logon. To do that, edit all other configurations and unselect the **Available for User Logon** checkbox. Save the change.

![Make the trust configuration to the SAP SuccessFactors identity provider the only configuration that is available for user logon.](screenshots.png/21-new-trust-config.png)
	
See [Establish Trust Between SAP SuccessFactors and SAP BTP](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/80a3fd16d144454fbe08377d284e3c37.html).

#### 9.2. Configure the subaccount as a trusted service provider in SAP SuccessFactors.

To configure the subaccount as a trusted service provider in SAP SuccessFactors, you have to create an **SAP SuccessFactors Extensibility** service instance using the **sso-configuration** service plan.

1. In the SAP BTP cockpit, navigate to the subaccount which you want to configure as a trusted service provider in SAP SuccessFactors.

2. In the navigation area, choose **Services** > **Service Marketplace**, and on the **Service Marketplace** screen, search for the **SAP SuccessFactors Extensibility** service.

3. In the **SAP SuccessFactors Extensibility** page, choose **Create**.

4. In the **New Instance or Subscription** wizard:

	* In the **Service** dropdown list, ensure you have selected the **SAP SuccessFactors Extensibility** service.
	* In the **Plan** dropdown list, select the **sso-configuration** service plan.
	* In the **Runtime Environment** dropdown list, select **Other**.
	* In the **Instance Name** field, enter a name for your instance, for example **sso-to-successfactors**. Choose **Next**.
	* To configure the assertion consumer service of the subaccount, specify the system name in the JSON file:
	
		`
		{"systemName": "my-sap-successfactors-system"}
		`
	
	For more information about the structure of the JSON file, see [Single Sign-On Configuration JSON File](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/5ec1e970eb0d417c969f1693da31388f.html).

5. Choose **Next**.

6. Choose **Create**.

You have an assertion consumer service for the subaccount created in SAP SuccessFactors and have the SSO between your subaccount in SAP BTP and your SAP SuccessFactors system.
		
See [Configure the Subaccount as a Trusted Service Provider in SAP SuccessFactors](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/9efe2a1d84c2458fb7b68d4df1bd13ee.html).


### 10. Test the Application


1. In the SAP BTP cockpit, navigate to **<your_Cloud Foundry_space>** > **Applications**, and then choose the **approuter-task-management** link to go to the **Overview** page of the application.

2. On the **approuter-task-management - Overview** page, choose the URL in the **Application Routes** screen area to open the application in your browser.
   
Alternatively, copy and paste this URL from **routes** property in a browser from **cf CLI** when execute the command:

      cf app approuter-task-management
      
## Licensing

Copyright 2021 SAP SE or an SAP affiliate company and task-management-sample-app-sfsf-solutions contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/task-management-sample-app-sfsf-solutions).