Show TOC

Procedure documentationTutorial part 4: Register App and Configuration 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 and the config 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 about Creating and Registering Dashboard Apps. During this tutorial, you create and register a number of apps and their associated BW queries.

You are performing this registration in the fourth part of the tutorial.

Note Note

Ensure that you have already performed the previous steps, as described in Tutorial Part 4: Creating a Complex App with a Config App.

End of the note.

Procedure

You register both apps in your SAP Solution Manager system.

Registering the Standard 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_4_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 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 ztut4_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 ztut4_metrics_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.

    • There is also a config app for the app. However, since you have not yet registered it, 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. In this case, select both of the following indicators:

    • The app requires data from a BW query. Therefore select the indicator Data Provided by BW Query.

    • The app also takes the metric to be displayed directly from the config app. Since this is not done through the BW query, select the indicator Other Values (Text, Values, etc).

    Now go to the third step of the registration by choosing Next.

  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 ZTUT4_METRICS_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 case, you are filtering by the month set in the config app. However, since the config app is not yet registered with the Dashboard Framework, enter only a default value of your choice for the month at this stage (0CALMONTH). The Source Type is therefore currently a Fixed Value.

      Enter the following row in the table:

      Filter Type

      InfoObject/Variable

      Source Type

      Source/Value From

      BW InfoObject

      0CALMONTH

      Fixed Value

      201111

    • 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 FROM_QUERY_COSTS.

      The month 0CALMONTH is also used as a data source in the app; for this purpose, enter the app connection MONTH in a separate row.

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

  6. In Text, Values, etc, specify the data sources for other connections of your app, that is connections for which the values (such as texts to be displayed) do not come from a BW query, but rather from a config app. In this tutorial, the app has three connections, two of which are supplied with values by a BW query. The remaining connection is SELECTED_METRIC.

    • In the Data Group Name table, enter any technical name for each of these connections. In this tutorial, this is METRIC.

    • Connect this technical name with one of the app's connections. In this tutorial, in the Inbound App Connection field, enter the connection METRIC. The value of this connection is to be configurable, that is, the user is able to change it in the config app. Select the indicator Is Configurable per App.

    • In the Xcelsius file for the app, a cell area consisting of two rows and one column is assigned to the METRIC connection. The first row is reserved for the technical name, while the actual number of the metric is in the second row. You reproduce that here in the registration.

      Therefore, in the Field1 column, in the first row, specify the technical name of the connection (METRIC), and in the second row, specify the default value for this number, for example 1.

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

  7. In Navigation, you can define further navigation options. This is not used in this part of the tutorial.

    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 Config 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 Configuration App radio button.

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

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

    • In the dropdown list Namespace, choose the namespace which you specified in the default 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 ztut4_config.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 ztut4_config.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.

    • When registering the associated app in the previous section, you could not yet specify the config app. You create this connection now, by selecting the Has Partner App indicator, and selecting the entry for the associated app, Z_TUTORIAL_4_APP, from the dropdown list box.

    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. In this case, select both of the following indicators:

    • The app requires data from a BW query. Therefore select the indicator Data Provided by BW Query.

    • The partner app also takes the metric to be displayed directly from the config app. Since this is not done through the BW query, select the indicator Other Values (Text, Values, etc).

    • Ensure that the Include Partner App Data Sources indicator is also selected. This means that the app's data sources are also available to the associated config app.

    Now go to the third step of the registration by choosing Next.

  5. On the BW Data screen, specify the relationship between the app and the BW query that provides the data to be displayed.

    • In the Filter for BW Query table, specify the characteristics to be used in the query to filter the values to be displayed. The settings of the associated app are copied.

      The default value that you specified when registering the app therefore already exists in the table for the month (0CALMONTH). However, it should also be possible to overwrite this default value with the settings of the config app, which means that you now also specify the connection of the config app MONTH_OUT, which passes the selected month.

      Therefore, in a new row for the BW:InfoObject 0CALMONTH, specify the Configuration App Connection with the connection name MONTH_OUT.

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

      The month 0CALMONTH is also used as a data source in the config app; for this purpose, enter the app connection MONTH_IN in a separate row.

      Note Note

      You can delete the row RESULT, which is always displayed.

      End of the note.

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

  6. In Text, Values, etc, specify the data sources for other connections of your app, that is connections for which the values (such as texts to be displayed) do not come from a BW query. This is the connection SELECTED_METRIC.

    • In the Data Group Name table, enter a technical name for each of these connections. In this tutorial, this is METRIC (see the registration of the associated app).

    • Connect this technical name with the config app connection. In this tutorial, in the fields Inbound App Connection and Outbound Connection, enter the connection SELECTED_METRIC (this is possible because the connection has the access type Read/Write). The value of this connection is to be configurable, that is, the user is able to change it in the config app. Select the indicator Is Configurable per App.

    • In the Xcelsius file for the app, a cell area consisting of two rows and one column is assigned to the SELECTED_METRIC connection. The first row is reserved for the technical name, while the actual number of the metric is in the second row. You reproduce that here in the registration.

      Therefore, in the Field1 column, in the first row, specify the technical name of the data group (METRIC), and in the second row, specify the default value for this number, for example 1.

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

  7. In Navigation, you can define further navigation options. This is not used in this part of the tutorial.

    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.

Result

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