Creating your first FSM Extension

location

First Lesson

Your SAP Cloud Platform Extension Factory is set up and you are wondering how you can create your first FSM extension with it?

Now what?

Well, in this lesson you'll learn the following:

Learn about preliminaries when using SAP Cloud Platform Extension Factory.
How to create your first extension app.
How to trigger automatic deployments leveraging SAP Cloud Platform Extension Factory and the FSM Extension App UI.
How to place your first extension app on a FSM Standard UI
Where to find useful information around building FSM extensions
Overview
location

1   |   Check preliminaries

The following guide expects certain preliminaries to be full filled before you start:

  • Your Extension Factory is up and running
  • FSM is connected with the Extension Factory
  • The FSM Extension Installer is configured and ready to be used

If your FSM Extension Installer is not yet set, kindly follow this guide to accomplish these preliminaries.

Preliminaries
location

2   |   Creating your first extension app

The sample extension app will showcase the connection between your extension and SAP FSM via the Shell SDK. Once all steps are done, the extension will be showing...

  • username
  • account
  • and company information of the logged on FSM user

It is recommend to not enhance the sample extension app with additional code when you do your first run through of the guide.

FSM Extension Sample

Important: Note down the Deployment Artifacts URL and Extension Name which you are creating while running the linked guide. You will need it in the next steps.

First Extension App
location

3   |   Automatic Deployment

Preliminaries

  • Preview mode is turned on
  • Your FSM user has access to Foundational Services / Extension Apps
  • Your FSM user has the Admin Role
  • You are logged on to FSM

Trigger automatic deployment to the Extension Factory

  • Navigate to Foundational Services / Extension Apps
  • Click on "Add Extension App" on the top-right of the screen
  • Select "Deployment Type": "Automatic"
  • Fill in "Deployment Artifacts URL which points to your artifact folder in your project"
  • If you have a dedicated namespace in that your extension should be deployed to: Fill in "Deployment Configuration": "{"namespace": "[your-namespace]"}", otherwise the extension will attempt to deploy to the default namespace.



  • Click "Next"
  • Click "Install"

Your extension app deployment on the Extension Factory is now triggered and after some minutes your app should turn from status "Installing" to "Active". Once your application is "Active" you can move on to the next section.

Note: When the extension is marked as "Active" it might still take some time until the endpoint of your extension is exposed in the Extension Factory.





Note: If you want to learn more deployment options you can find further information in Manage Extensions via UI and Deploying via API.

Automatic Deployment
location

4   |   Place your extension on a standard screen

After you have successfully deployed your app let's assign it to a FSM standard screen which is enabled for extensions.

Preliminaries

  • Preview mode is turned on
  • Your FSM user has access to Planning and Dispatching / Dispatching Board
  • Your FSM user has the Admin Role
  • You are logged on to FSM

Now let's place the extension on a standard screen

  • Navigate to Planning and Dispatching / Dispatching Board
  • Click on the three-dot Button on the Top Right Corner
  • Click on "Open Extension Configuration"
  • A section called "PLUG-IN" will appear on the right side of the Dispatching Board, click on "Add Plug-In"



  • A dialog window will open. Select your extension. You can identify it by the name that you provided in step 2



  • Click "Add"
  • Your extension should now be displayed and show username, account and company information



  • Now you can close the configuration mode by clicking on the top central orange button called "Configuration Mode"

Note: If you want to learn more about placing extensions...

Extension Placement
Location

Next Steps

Congratulations you now have run through the basic steps of creating an FSM extension running on SAP Cloud Platform Extension Factory! Find more extension relevant information collected in the Extensions Overview page

Next Steps