Show TOC

Procedure documentationTutorial part 5: Register the App Locate this document in the navigation structure

 

This tutorial is part of a course that explains the creation and registration of apps for the Dashboard Framework. In this step, you register the app which you created in the previous step of the tutorial. Only once you have done this can you display the app in your dashboards.

Prerequisites

This procedure is part of a comprehensive tutorial about Creating and Registering Dashboard Apps. During this tutorial, you create and register apps and their data sources.

In the fifth part of the tutorial, you create a simple app with an associated BAdI implementation, which you register in your SAP Solution Manager system in this step.

Note Note

You should already have worked through the previous step, as described in Tutorial part 5: Create App with Data Provided by BAdI.

End of the note.

Procedure

You register the app in your SAP Solution Manager system.

  1. Start the registration by double-clicking your entry, Registration of Apps, in the SAP Easy Access Menu.

    Note Note

    For more information about creating an entry in the SAP Easy Access menu, and for information about registering apps within this tutorial, see Tutorial Part 1: Registering the App.

    End of the note.
  2. Choose Register New App.

  3. On the General Settings screen, enter the following data:

    • Select the Standard App radio button.

    • In the Technical Name field, enter the technical name of the app. In this tutorial, this is Z_TUTORIAL_5_APP.

    • In the Short Text and Description input fields, enter a short description of the app.

    • In the Namespace dropdown list box, choose a namespace. You may have to create it first. For more information, see Registering User Apps in the Dashoard Infrastructure.

    • In the Categories dropdown list box, choose the entry that represents the appropriate topic for the app from the user's point of view; you can specify multiple categories. In this tutorial, choose the category Not Assigned.

    • The Authorization Group dropdown list box specifies whether an authorization check is to be performed when the app is called. In this tutorial, choose the entry Public, which means that no additional authorization check is performed.

    • In App Flash File (SWF), specify the storage location of the flash file that contains the app. In this case, this is the storage location of ztut5_costs_month.swf, which you created in the previous part of the tutorial.

    • In Icon File (JPG), specify the storage location of an image file that is to represent the app in the relevant interfaces. In this tutorial, choose any image file of the type JPG.

    • In Xcelsius File (XLF), specify the storage location of the Xcelsius file that contains the app. In this case, this is the storage location of ztut5_more_info.xlf, which you created in the previous part of the tutorial.

    • You only require the input fields Customizing Request for App Type and Workbench Request for Files if you want to transport the app (see Extending the Dashboard Framework with User Apps). This is not the case in this tutorial, so leave the input fields empty if the settings in your system permit this.

    • Since there is no config app for this app, do not select the Has Config App indicator.

    Now move to the second step of the registration by choosing the Next button.

  4. On the Data Sources of Apps screen, specify the sources of the data that is displayed in the app.

    The app that you have created requires a BAdI implementation for its data (Data Provided by BAdI). In this step, therefore, select the specified indicator.

    Note Note

    As additional information, the user interface and the connections of the app that you created when creating the Xcelsius file are displayed. By selecting the Listen to Changes indicator, you can have a change in the data for the connection generate an event in the backend that immediately reacts to this change. This is not necessary in this tutorial.

    End of the note.

    Now move to the third step of the registration by choosing the Next button.

  5. On the BAdI Data screen, specify the relationship between the app and the BAdI implementation that provides the data to be displayed. TUTORIAL_FILTER is the BAdI filter value which you created in the previous part of this tutorial. Enter this value in the BAdIs subscreen.

    • In the table BAdI Parameters, you can enter the values of parameters which the BAdI impementation uses. In this example, there are no such parameters.

    • In the table BAdI Results and App Connection Data Flow, specify which Content Name in BAdI belongs to which Incoming App Connectiong (see Tutorial part 5: Create BAdI Implementation). In this example, both objects have the name FROM_BADI, so enter this value in both columns in the table.

    Go to the fourth step of the registration by choosing the Next button.

  6. In Navigation, you can define further navigation options. Since you do not want to use this in this part of the tutorial, do not enter anything here.

    Now move to the final step of the registration by choosing the Next button.

  7. In the App Type Settings step, you can check your settings again. Exit the Wizard by choosing the Finish button.

Result

You have registered the app that you created in the Dashboard Framework and can display it in your dashboards.