Show TOC

Procedure documentationTutorial part 2: Register App and Detail 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 detail app 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 this second part, you extend a simple app with a drill down, that is, the possibility of calling one app from another, depending on the context.

Note Note

Ensure that you have already performed the previous steps, as described in Tutorial Part 2: Creating an App with Additional Navigation.

End of the note.

Procedure

You register both apps in your SAP Solution Manager system.

Note Note

During the registration of the app and of the detail app, you need to make specifications that relate to the other app. In this tutorial, you register the detail app first. However, during this registration, you specify that the selected branch is passed to this detail app in a context called LOCATION. You only define this context later, during the registration of the app.

End of the note.
Registering the Detail App
  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_2_DETAIL.

    • 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 Not Assigned.

    • In the Authorization Group dropdown list box, choose the Public entry.

    • 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 ztut2_costs_day.swf, which you created earlier in 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 ztut2_costs_day.xlf, which you created earlier in the tutorial.

    • Leave the input fields Customizing Request for App Type and Workbench Request for Files 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 data from a BW query and from a dashboard context. In this step of the wizard, therefore, select the specified indicators.

    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 ZTUT2_COSTS_DAY, 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. Since this detail app is to display only the data for the selected branch (BW InfoObject 0CCM_SRCL), this is a filter of precisely this type. A context called LOCATION, which you will create when registering the app below, is to be passed to the detail app. Therefore, enter the following values in a row:

      Column

      Entry

      Filter Type

      BW: Info Object

      InfoObject/Variable

      0CCM_SRCL

      Source Type

      Context

      Source/Value From

      LOCATION

    • 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_DAY; the connection that you created when creating the Xcelsius UI.

    Go to the next step in the registration by choosing the Next button.

  6. On the screen Data Provided by Dashboard Context, specify the connection through which the context (in this case, LOCATION) is to be supplied with values. This is the connection SEL_LOCATION, which you created in the Xcelsius user interface of the detail app. Therefore, enter the following values in a row:

    Column

    Entry

    Dashboard Context Name

    LOCATION

    Outgoing App Connection

    SEL_LOCATION

    Go to the next step in the registration by choosing the Next button.

  7. In Navigation, you can define further navigation options. Since you are working at the level of the called detail app here, from which no further drill down is to be possible, do not enter anything here.

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

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

Registering the Standard App
  1. Start the registration by double-clicking your entry, 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_2_APP.

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

    • In the dropdown list Namespace, choose the namespace which you specified in the detail app.

    • In the Categories dropdown list box, choose the entry Not Assigned.

    • In the Authorization Group dropdown list box, choose the Public entry.

    • 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 ztut2_costs_month.swf, which you created earlier in 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 ztut2_costs_month.xlf, which you created earlier in the tutorial.

    • Leave the input fields Customizing Request for App Type and Workbench Request for Files 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 data from a BW query. In this step of the wizard, therefore, select only this indicator.

    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.

    Go to the next step in the registration by choosing the Next button.

  6. In Navigation, you can define further navigation options. This is the core of this part of the tutorial. First specify a navigation option in the Navigation Targets table. A navigation option of this type contains a unique technical name (ID), which you can define here, a descriptive short text (Description), and a Target Type, with which you specify what is actually called when a navigation of this type is performed.

    • In this tutorial, enter the following values in a row of the Navigation Targets table:

      Column

      Entry

      ID

      JUMP_SELECTION

      Description

      Daily Costs

      Target Type

      List of Apps

    • The navigation is always to be triggered, if the value in the connection SEL_LOCATION changes, that is, if the user has clicked a different branch in the higher-level app. Therefore, select the radio button Change in App Connection, and, in the associated dropdown list box, choose the entry SEL_LOCATION.

    • You can specify whether or not the detail app is to be displayed in a separate operating system window. This is not the case here, so select the radio button Embedded.

    • You specified above that a list of apps is to be displayed during navigation. In this case, it is only one app, and that is the detail app that you registered above. Therefore, in the table List of Detail Apps, use the input help to enter the app Z_TUTORIAL_2_DETAIL.

    • The detail app requires the selected branch; the connection SEL_LOCATION is used to pass this information. However, the actual transfer of the branch data is performed in the context LOCATION, which you specified above during the registration of the detail app. Enter the following values in a row of the Mapping of Outgoing App Connections to Target Context table:

      Column

      Entry

      Outgoing App Connection

      SEL_LOCATION

      Target Name

      LOCATION

    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 apps that you created in the Dashboard Framework and can display them in your dashboards.