Show TOC

Creating Tags in the Tag TableLocate this document in the navigation structure

Use

You can use tags to exchange data between an application running in the content area and the side panel. Tags relate to properties of the UI elements that you extract from an SAP GUI transaction using SAP GUI Property Collector. You map the collected properties to tags and pass them to the side panel. The tag table stores the tags in the SAP back-end system. This table is read by SAP Business Client at runtime and controls the extraction process. The relevant properties are identified by the program name, the screen name, and the field ID.

Depending on the server runtime you are using, different tag tables and maintenance views are involved:
  • Server runtime for SAP Business Client

    SAP GUI tags are specified in the following SAP_BASIS tables:
    • NWBC_S_GUI_TAG: Contains entries that are delivered by SAP

    • NWBC_C_GUI_TAG: Contains entries that are maintained by the customer

  • Server runtime for SAP NetWeaver UI services

    SAP GUI tags specified for the server runtime for SAP Business Client in the above mentioned SAP_BASIS tables continue to be read by the server runtime for SAP NetWeaver UI services. In addition, the following tag views are available:
    • /UI2/NWBC_V_GT: Contains entries that are delivered by SAP

    • /UI2/NWBC_VC_GT: Contains entries that are maintained by the customer. The entries are merged following this logic:
      • The customer's entries supersede SAP entries.

      • Entries for the server runtime for SAP NetWeaver UI services supersede SAP_BASIS entries.

Procedure

To insert the data that you have extracted using SAP GUI Property Collector, proceed as follows:

  1. In Customizing (transaction SPRO), choose:
    • Start of the navigation path SAP NetWeaver Next navigation step UI Technologies Next navigation step SAP NetWeaver Business Client Next navigation step Define SAP GUI Tags (Runtime for SAP NetWeaver User Interface Services) End of the navigation path when using the server runtime for SAP NetWeaver UI services.

    • Start of the navigation path SAP NetWeaver Next navigation step Application Server Next navigation step Frontend Services Next navigation step NetWeaver Business Client Next navigation step Define SAP GUI Tags End of the navigation path when using the server runtime for SAP Business Client.

  2. Choose the New Entries pushbutton.

    Insert the properties from the Windows clipboard into the table by pressing CTRL + V.

  3. Specify a tag name and a description. We recommend that you use a namespace for the tag name.

    You can use the input help to select tags. For more information, see Tagging Framework.

  4. You can use asterisks (*) for the Program Name field and the Screen field if the same SAP GUI field is used on multiple screens or in multiple programs. For example, you can use 1* for all screens that start with 1 (100, 101, 110, 120, and so on).

    Note In case of duplicate tag names, the following rules apply:
    1. The customer's entries supersede SAP entries.

    2. Entries in the SAP NetWeaver UI tag tables supersede entries in SAP_BASIS tag tables.

    3. Tags with the most specific screen number take precedence, for example:

      “301” > “”

      “301” > “3*”

      “301” > “301*”

      “30*” > “3*”

  5. You can use constants. In this case, you use a special syntax instead of pasting the properties from the clipboard. In the Property (SAP GUI Scripting) field, enter value:<constant>.

    Example

    A use case for constants is the assignment of business object types to screens. This is useful for generic side panel applications that interpret the business object type.

  6. Select the lifetime for the property. You have the following options:

    • Transaction

      The data context stays available as long as the current transaction is running in SAP Business Client.

    • Main Screen

      The data context stays available as long as you do not leave the main screen.

  7. By entering a data element, you can control the data extraction to convert from external to internal format on the application system by using the conversion service. This mechanism is helpful if the processing logic of the side panel application needs the appropriate format for calling the application system. The data element is then used to derive the appropriate conversion exit on the application system.

  8. Specify a development package.

  9. Save your entries.

  10. Restart SAP Business Client for Desktop.

For more information, see the field help.

The tag exposes the referenced property value to the SAP Business Client data context. From the selection screen, you can display, create, edit, or transport the tags. Note that an area of SAP GUI tags is always transported.

Note You can create multiple tags for the same field. For example, for field FIELD_1, you have created two tags TAG_1 and TAG_2. For the CHIP import parameter PARAMETER_1, there are also two tags available: TAG_1 and TAG_2. The automatic wiring does not work here. In the Page Builder data context, it is not known that the tags TAG_1 and TAG_2 refer to the same field. Therefore, there is a conflict whether import parameter PARAMETER_1 is to be associated with TAG_1 or TAG_2. We recommend that you do not define multiple tags for CHIP import parameters.