--- title: Implement a Custom Shell Plug-in in the SAP BTP ABAP Environment description: Learn how to develop and deploy a custom shell plug-in to your SAP BTP ABAP Environment as part of a SAP Fiori Application. keywords: tutorial auto_validation: true time: 45 tags: [ tutorial>intermediate, programming-tool>abap-development, software-product>sap-business-application-studio, software-product-function>sap-s-4hana-cloud--abap-environment] primary_tag: software-product>sap-btp--abap-environment author_name: Tolgonai Muratbekova author_profile: https://github.com/TolgonaiMuratbekova parser: v2 slug: abap-environment-shell-plugin canonical_url: https://developers.sap.com/tutorials/abap-environment-shell-plugin --- ## Prerequisites - You have access to a SAP BTP Subaccount with a SAP Business Application Studio subscription. - You have access to a SAP BTP ABAP Environment in a Cloud Foundry space in the subaccount. - You have connected SAP Business Application Studio to your SAP BTP ABAP Environment via destination. - You have a user in the subaccount, with `Business_Application_Studio_Developer` role collection. - You are a member of the Cloud Foundry space where your SAP BTP ABAP Environment resides, and you have **Space Developer** role. - You have a user in your SAP BTP ABAP Environment with the following roles: `SAP_BR_ADMINISTRATOR` and `SAP_BR_DEVELOPER`. - You are connected to your SAP BTP ABAP Environment in the ABAP Development Tool (ADT) in Eclipse. >This tutorial was written for SAP BTP ABAP Environment. However, you should be able to use it in SAP S/4HANA Cloud Environment in the same way. >Throughout this tutorial, you will create various development objects and UI components. Wherever the suffix `###` or `000` is used, please replace it with your initials or group number. ## You will learn - How to create a custom shell plug-in. - How to deploy the shell plug-in to your SAP BTP ABAP Environment as part of a SAP Fiori Application. - How to create a Business Catalog and Business Role to regulate access to the SAP Fiori Application. --- ### Create a Package in ABAP Developer Tool in Eclipse The shell plug-in will be deployed to the local `ZLOCAL` software component in your SAP BTP ABAP Environment. For this reason, you need to create a local package in ADT. 1. Access ABAP Developer Tool in Eclipse and connect to your SAP BTP ABAP Environment. 2. Right click on your SAP BTP ABAP Environment and click on **New** > **ABAP Package**: ![Create new package](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_new_package_1.png) 3. Input a name and a description for your package. Make sure that the **Package Type** is **Development**. Click on **Next**. ![Create new package - name and description](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_new_package_2.png) >For the scope of this tutorial, the package name is `Z_PLUGIN_###`. You can use this name or choose your own package name. But make sure that your package name starts with `Z`. Take note of the name of the package you just created, you will need it in a later step. You can also mark the **Add to favorite package** option, so the package will be automatically added to your favorites and it will be easier to find later on. 4. In the **Software Component** field input `ZLOCAL`. Click on **Next**. ![Create new package - select software component](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_new_package_3.png) 5. Click on **Finish**. The package will be created. ![No tr creation, just finish](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_transport_request.png) ### Create a SAPUI5 Project in Business Application Studio The shell plug-in will be deployed to your SAP BTP ABAP Environment as an SAP Fiori component. As components are not fully supported yet by SAP Fiori tools but are structurally very similar to SAP Fiori applications, you can make use of some SAP Fiori tools for applications. First you need to create an empty SAP Fiori Application in Business Application Studio. 1. In your SAP BTP Subaccount, navigate to the **Instances and Subscriptions** tab in the left panel. In the **Subscriptions** tab, click on the **SAP Business Application Studio** link to access your instance of the SAP Business Application Studio. ![Access BAS from BTP](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/BAS_in_BTP.png) 2. Click on **Create Dev Space** button in the top right corner, input a Dev Space name, for example `_SAP_Fiori` (1) and select the application type **SAP Fiori** (2). Click on **Create Dev Space** (3). ![Create Dev Space in BAS](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_dev_space.png) 3. It might take a couple of minutes that the status of the new dev space switches from `STARTING` to `RUNNING`. Once it is running, click on its name to access it. ![Access Dev Space](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/bas-enter-dev-space.png) 4. In the **Get Started** tab click on **Start Project from Template**. Select the **SAP Fiori generator** project type template (1) and click on **Start** (2). ![Create SAP Fiori application](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_1.png) >If the **Get Started** tab is missing, enter `>Fiori: Open Application Generator` into the search bar and click the found result. 5. Select **Basic** Fiori application template (1) and click on **Next** (2). ![Create SAPUI5 project](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_2.png) 6. Data Source and Service Selection: In the **Data source** dropdown menu, select **None** and click on **Next**. ![Create SAP Fiori application - Data source](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_3.png) 7. Entity Selection: In the **View name** field, choose a view name and click on **Next**. ![Create SAP Fiori application - Entity selection](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_4.png) >For the scope of this tutorial the view name is `plugin_view`. You can use this name or choose a different name. If you choose a different view name, make sure to keep it consistent throughout the rest of the tutorial. While developing a SAP Fiori Application it is good practice to add the suffix `_view` to the name of your view. 8. Project Attributes: Input a **Module name**, an **Application title** and a **Description** of your choice. Select the **Add deployment configuration** option and the **Add FLP configuration** option. Click on **Next**. ![Create SAP Fiori application - Project attributes](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_5.png) >Ensure that **Use Virtual Endpoints for Local Preview** remains set to **No**. 9. Deployment Configuration: In the **Please choose the target** dropdown menu, select **ABAP**. In the **Destinations** dropdown menu, select the destination that points towards your SAP BTP ABAP Environment. Input for example `z_plugin_###` as name for the **SAPUI5 ABAP Repository** and a **Deployment description**. In the **Package** field, input the name of the package that you created in ABAP Development Tool in Eclipse in the previous step. Click on **Next**. ![Create SAP Fiori application - Deployment configuration](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_6.png) >Once the destination and package name have been entered, the system verifies whether the package is local. If this is the case, the Transport Request field is automatically disabled. 10. Fiori Launchpad Configuration: In the **Semantic Object** field input `Shell###` and in the **Action** field input `plugin`. Input a **Title** of your choice. Click on **Finish**. The project folder will be generated. ![Create SAP Fiori application - Fiori Launchpad Configuration](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_SAPUI5_project_7.png) >Make sure to input the fields with the correct cases: `Shell` must start with an upper case and `plugin` must start with a lower case. ### Adjust your SAPUI5 Project The application project is automatically initialized with several basic folders, files and configurations which are not correct for a component project. To create a shell plug-in of type component and deploy it, you need to change some of these initial configurations. 1. In Business Application Studio, open the folder of the project you just created and navigate to the **`webapp`** folder. Double click on the **`manifest.json`** file to open it. ![Open manifest.json file](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/open_manifest_json.png) 2. In the **`manifest.json`** file, modify the following configurations: - Under the `"sap.app"` configuration adjust the `"type"` property value to `"component"`. - Under the `"crossNavigation"` configuration remove the `"title": "{{flpTitle}}"` property and add the property `"hideLauncher": true`. - Remove the blocks for the `"routing"` configuration and the `"rootView"` definition. - At the end of the file, behind the second last `}`, insert the following code snippet: `,"sap.flp": {"type": "plugin"}`. At the end your **`mainfest.json`** file should look like the following (certain properties are project-dependent and might therefore have different values for you. For this reason, you should use this code snippet as a guide, and manually adjust your **`mainfest.json`** file (rather than simply copy and paste this code snippet)): ``` JSON { "_version": "1.58.0", "sap.app": { "id": "zplugin###", "type": "component", "i18n": "i18n/i18n.properties", "applicationVersion": { "version": "0.0.1" }, "title": "{{appTitle}}", "description": "{{appDescription}}", "resources": "resources.json", "sourceTemplate": { "id": "@sap/generator-fiori:basic", "version": "1.11.4", "toolsId": "ca6d90b1-7c62-441c-8145-fa747953cc5c" }, "crossNavigation": { "inbounds": { "Shell000-plugin": { "hideLauncher": true, "semanticObject": "Shell000", "action": "plugin", "signature": { "parameters": {}, "additionalParameters": "allowed" } } } } }, "sap.ui": { "technology": "UI5", "icons": { "icon": "", "favIcon": "", "phone": "", "phone@2": "", "tablet": "", "tablet@2": "" }, "deviceTypes": { "desktop": true, "tablet": true, "phone": true } }, "sap.ui5": { "flexEnabled": true, "dependencies": { "minUI5Version": "1.120.1", "libs": { "sap.m": {}, "sap.ui.core": {}, "sap.f": {}, "sap.suite.ui.generic.template": {}, "sap.ui.comp": {}, "sap.ui.generic.app": {}, "sap.ui.table": {}, "sap.ushell": {} } }, "contentDensities": { "compact": true, "cozy": true }, "models": { "i18n": { "type": "sap.ui.model.resource.ResourceModel", "settings": { "bundleName": "zplugin###.i18n.i18n" } } }, "resources": { "css": [ { "uri": "css/style.css" } ] } }, "sap.flp":{ "type": "plugin" } } ``` 3. Delete the **`controller`** folder (This is a sub-folder of the **`webapp`** folder) with all its content. ![Delete controller folder](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/delete_controller_folder.png) 4. Delete all the content in your **`view`** folder (This is a sub-folder of the **`webapp`** folder). Do not delete the **`view`** folder itself, you will need it in a later step. ![Delete view folder content](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/delete_view_content.png) 5. Open the **`Component.js`** file in the **`webapp`** folder. You should use this code snippet as a guide, and manually adjust your Component.js file (rather than simply copy and paste this code snippet): ``` JavaScript sap.ui.define([ "sap/ui/core/UIComponent" "zplugin000/model/models" ], function (UIComponent, models) { "use strict"; return UIComponent.extend("zplugin###.Component", { metadata: { manifest: "json" }, /** * The component is initialized by UI5 automatically during the startup of the app and calls the init method once. * @public * @override */ init: function () { // call the base component's init function UIComponent.prototype.init.apply(this, arguments); var oRenderer = sap.ushell.Container.getRenderer(); var oEntry = { title: "Personalized shell plug-in", icon: "sap-icon://role", value: function () { return jQuery.Deferred().resolve("Plug-in example"); }, content: function () { return jQuery.Deferred().resolve(new sap.m.Text("plugin-text", {text: ""})); }, onSave: function () { return jQuery.Deferred().resolve(); } }; oRenderer.addUserPreferencesEntry(oEntry); } }); } ); ``` >In line 8, the `"zplugin###.Component"` is taken from the name of your project. If you chose a different project name in the previous step, make sure to substitute the `zplugin###` with the correct project name. The name of your project can be found in the **`manifest.json`** file under the `"sap.app"`>`"id"` property. ### Preview your SAPUI5 Component Your basic SAPUI5 Component can be previewed before it is deployed. Using the preview functionality is good practice before deploying a user interface, to make sure that it looks as intended and functionalities work as desired. 1. In Business Application Studio, In the **Storyboard** tab right click on your UI Application and click on **Open Application Info**. ![Preview application](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Preview_app_1.png) >The **Storyboard** tab can always be opened from the Search bar by typing the command `> Open Storyboard`. 2. In the **Application Info** view, select the **Preview Application** tile. ![Preview application 2](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Preview_app_1_2.png) 3. Select **start fiori-run**. This will prompt a new terminal window which will run the **start fiori-run** command. This can take up to a few seconds. Once it is done, a preview of your application will open up in a new browser window. ![Preview application - start fiori run](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Preview_app_2.png) 4. In the preview of your component, click on the user icon in the top-right corner and open the **settings**. Your shell plug-in is listed in the user's settings dialog. ![Application preview - settings](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Preview_app_3.png) ![Application preview - shell plug-in](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Preview_app_4.png) >The shell plug-in is currently empty. You will implement it in a later tutorial. ### Deploy your SAPUI5 Component You can now deploy your SAPUI5 Component on with a basic (empty) shell plug-in to your SAP BTP ABAP Environment. 1. In Business Application Studio, in the **Application Info** view, click on the **Deploy** tile: ![Deploy application](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/deploy_application.png) >In case the Deploy tile is not visible in the Application Info, right-click the ui5-deploy.yaml file, select Open in Integrated Terminal, and execute the command **npm run deploy**. 2. The deployment process will begin. You will be prompted to confirm the deployment by typing `Y`. Once the SAPUI5 Application is successfully deployed to your SAP BTP ABAP Environment, the terminal will return the status: `Deployment Successful`. You can now close the terminal window. >The deployment process can take up to a few minutes. 3. After a successful deployment, your software package in ABAP Developer Tool in Eclipse will be automatically enhanced by a BSP Application, a Launchpad App Descriptor Item and `SICF` Node. ![New ADT files](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/new_ADT_files.png) ### Create an IAM App Now that your basic shell plug-in has been successfully deployed to your SAP BTP ABAP Environment as part of a SAPUI5 Application, you need to assign the application to a Business Catalog. To do this, you first need to create an IAM App, which points to your deployed SAPUI5 Application. (You will assign the IAM App to a Business Catalog in a later step). 1. Access ABAP Developer Tool in Eclipse and connect to your SAP BTP ABAP Environment. 2. Right click on your package and select **New** > **Other ABAP repository object**. ![Create business catalog 1](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_1.png) 3. In the search bar, search for **IAM App** and click on it. ![Create business catalog 2](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_2.png) 4. Enter a name and a description for the IAM app. Keep **External App** as the **App Type**. ![Create business catalog 3](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_3.png) 5. Click on **Next**, then on **Finish**. 6. In the newly created **IAM App**, enter the name of your **Launchpad App Descriptor Item** in the corresponding field (1) and save ( **File** > **Save**). Then click on **Publish Locally** (3). ![Publish locally](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/publish_locally.png) >Publishing the IAM App can take up to a couple of minutes. You can keep track of the process in the lower right corner of the ABAP Developer Tool in Eclipse. ### Create a Business Catalog Now that you have created the IAM App, you can create a Business Catalog and assign the IAM App to it. 1. In the **IAM App**, click on the link **Create a new Business Catalog and assign the App to it**. ![Create business catalog 4](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_4.png) 2. Enter a name and description. ![Create business catalog 5](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_5.png) 3. Click on **Next**, then click on **Finish**. 4. A new window will automatically pop up prompting you to create the Business Catalog App Assignment. Click on **Next**, then on **Finish**. ![Create business catalog 6](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_6.png) 5. The generated IAM App, IAM App to Catalog Assignment and IAM Business Catalog will appear in your project folder. 6. Double click on the IAM Business Catalog file to open it. Click on **Publish Locally**. ![Create business catalog 8](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/create_business_catalog_8.png) >Publishing the Business Catalog can take up to a minute. You can keep track of the process in the lower right corner of the ABAP Developer Tool in Eclipse. >Make note of your Business Catalog ID, you will need it in a later step. ### Create a Business Role Now you need to create a Business Role in your SAP BTP ABAP Environment and then assign the Business Catalog to it. Any user in your SAP BTP ABAP Environment with this Business Role will have access to the shell plug-in. 1. Access the Fiori Launchpad of your SAP BTP ABAP Environment. 2. Search for the **Maintain Business Roles** application and open it. ![Create business role 1](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_1.png) 3. In the lower right corner, click on **New**. Enter a **Business Role ID** and a description. Click on **Create**. The Business Role will be created and will open automatically. ![Create business role 2](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_2.png) 4. In the **Assigned Business Catalogs** tab, click on 'Add' to add your Business Catalog. ![Create business role 4](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_4.png) Search for your Business Catalog, select it and click on **OK**. ![Create business role 5](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_5.png) 5. In the **Assigned Business Users** tab, click on **Add**. ![Create business role 6](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_6.png) Search for your user name, select it and click **OK**. 6. In the **General Role Details** tab, change the value for the **Write, Read, Value Help** attribute to **Unrestricted**. Then click on **Save**. ![Create business role 7](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_7.png) ### Test your Shell Plug-in You have successfully created an empty shell plug-in and deployed it to your SAP BTP ABAP Environment as part of a SAPUI5 Application. You have setup the IAM App, the Business Catalog and the Business Role. Any user with this Business Role will now see the shell plug-in in the user settings dialog: click on the user icon in the top right corner, and click on **Settings**. ![Create business role 8](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-shell-plugin/Create_business_role_8.png) >You might have to refresh the webpage for the shell plug-in to appear in the **Settings**. In the next tutorial, you will learn how to enrich your shell plug-in making use of OData Services. ### Test Yourself