Show TOC

Procedure documentationTutorial part 1: Register the App

 

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 and the BW query that you created in the previous steps 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 on the topic Creating and Registering Dashboard Apps. During this tutorial, you create and register a number of apps and their associated BW queries.

In the first part of the tutorial, you create a simple app with an associated BW query, and in this step, you register these in your SAP Solution Manager system.

Note Note

Ensure that you have already performed the previous steps, as described in Tutorial Part 1: Creating and Registering a Simple App.

End of the note.

The registration is performed using a Web Dynpro application called dashboard_apploader. Call a Web Dynpro application as follows:

  1. In the SAP Easy Access menu, call Start of the navigation path Favorites Next navigation step Add Other Objects End of the navigation path.

  2. From the list in the Restrictions screen, choose Web Dynpro Applications.

  3. On the Web Dynpro Application screen, in the Web Dynpro Application field, enter the name dashboard_apploader.

  4. Enter a description, for example Registration of Apps, and complete the creation of the new entry.

Procedure

You register the app in your SAP Solution Manager system.

  1. Start the registration by double-clicking the entry that you created above, Registration of Apps, in the SAP Easy Access Menu.

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

    • In the Short Text and Description input fields, enter any suitable 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 ztut1_costs_month.swf, which you created in the first 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 ztut1_costs_month.xlf, which you created in the first 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 only a BW query for its data (Data Provided by BW Query). 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 BW Data screen, specify the relationship between the app and the BW query that provides the data to be displayed. In this tutorial, the associated query is ZTUT1_COSTS_MONTH, which you created earlier in the tutorial. Therefore enter this query in the BW Queries subscreen.

    • In the Filter for BW Query table, specify the characteristics to be used in the query to filter the values to be displayed. In this example, there are no filters of this type. Although only data for the last month is displayed, this filtering is done in the BW query itself.

    • In the Usage of BW Query Result in App table, you specify how the results of the query are used.

      In the column Source of Data, there is already a row with the entry RESULT. Specify here the app's connection to which the results of the query are forwarded. In this tutorial, this is the connection FROM_QUERY_COSTS; the connection that you created when creating the Xcelsius UI.

    Now move 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.