Show TOC

Defining Node ResponsesLocate this document in the navigation structure

Use

In this step of the roadmap, you can define optional settings for the search and analysis model. Depending on the type of the model, you can define the following settings:

  • Response attributes

  • Authorizations

  • Related requests

  • Navigation targets

You define these settings on the corresponding tab pages at the bottom of the screen.

Note

This screen only shows the internal nodes of the model, not the nodes you have added using associations.

Once you have defined authorization objects, response attributes, related queries, and navigation targets for a node, the corresponding checkboxes in the Auth. Response Attributes, Rel. Queries, and Nav Targets columns in the overview area are selected for this node. This gives you an overview of the nodes and properties you have already worked on.

Prerequisites
  • To import an authorization object, you must know the exact name of the object, there is no selection list.

  • To define a back-end operation for back-end navigation, you must know the transaction code of the operation and the screen field name of the target attribute in the back-end system.

Procedure

Defining Response Attributes

You can add additional response attributes from nodes other than the node currently selected. Additional response attributes can be selected from all the nodes that are linked to the current node through an arbitrary number of steps but with cardinality "up to one" or "exactly one". An exception to this rule is text nodes (cardinality "arbitrary"), because the cardinality is "exactly one" for a specific language.

  1. Select the node for which you want to define response attributes.

  2. Choose the Response Attributes tab.

    All the response attributes of the selected node that you selected in step 2 (Define Nodes) appear. Here you can add the response attributes of other nodes. This feature is available for text nodes (Language Field attribute property was set in step 2) or nodes that are linked with the cardinality Up to one or Exactly one.

  3. To add a response attribute, choose Add.

    In the dialog box in the upper table, select the node that contains the required attributes.

    In the lower table, select the attributes that you want to add as response attributes and choose Select.

    The attributes are added to the list.

  4. Define how and where the individual attributes are to appear on the Search UI. The application using Embedded Search must support this setting.

    1. In the left-hand table in which all attributes are entered, choose an attribute.

      The possible UI area assignments for the attribute are displayed on the right side of the table Details: UI Area Assignment of Node Field <attribute_name>.

    2. Select the required UI areas for the attribute. The following UI areas are available:

      UI Area

      Explanation

      Title

      The response attribute is used as the object title.

      Summary

      This attribute appears in the UI area Summary as one of the entries 1-9 after the UI area Title and is displayed in the form of attribute/value pairs.

      The attributes 1-9 are displayed in a 3x3 matrix in the following order:

      1-2-3

      4-5-6

      7-8-9

      Thumbnail

      Used for the picture that is displayed in the default view in the UI area Summary.

      This function is not yet supported by Web Dynpro in Release 7.02.

      Details

      The attribute is displayed in the details section when the corresponding object instance is selected in the Search UI.

      Detail Screen

      Used for the picture that is displayed in the detailed view in the UI area Details.

      This attribute is a URL that refers to the picture to be displayed.

Defining Authorizations

You can define authorization checks to be performed for the nodes in a business object by adding authorization objects to the node. In this way, you can configure, for example, that only users that have read access to customer master data in the SAP system obtain customer master data as search results.

You also define authorization checks for operational data providers here. For more information about this, see Modelling Authorizations.

  1. Select the node for which you want to define an authorization object.

  2. Choose the Authorization tab.

  3. There are two further tabs: Choose the ABAP Auth. Objects tab to perform the authorization check in the search result. Choose the Auth. Paths tab to define the authorization check using a path specification.

  4. Optional: Import authorization object definitions from a connected back-end system:

    1. Choose Import.

    2. Enter the name of the authorization object that you want to import in the Authorization Object field.

    3. Choose Import.

  5. Choose Add to add a new row to the table. Place the mouse cursor in the Check ID field in the highlighted row and then choose F4 to display the available authorization objects. Select one or more authorization objects in the dialog box and choose Select.

  6. Define the fields of the authorization objects:

    1. Select an authorization object whose details you want to display in the area Details: Fields of Authorization Object <object_name>.

    2. Enter the relevant values for the authorization fields. They can be one of the following:

      • Fixed Value: Enter a fixed value in the Value column.

        You can also enter several values separated by semicolons.

        Example

        You can enter the fixed values 02;03 for the ACTVT attribute to grant access to search results for this node for which the search user has display and change rights for the node.

      • A value dynamically retrieved from an attribute at search runtime:

        1. Click into the Target Attribute or Reference Node column and choose F4.

        2. Navigate to the required node in the structure, select it, and select the attribute holding the required value from the list.

          The target attribute and reference node appear in the area Details: Fields of Authorization Object <object_name>.

          Example

          A target attribute could be the attribute holding the customer number.

Defining Related Queries

You can use existing queries for related search object connector models that include query attributes that belong to the selected node as related actions on the Search UI. The application using Embedded Search must support this function. To display other queries here, you must have defined an association between the models.

Example

You are modeling a material model. You have defined an association to a customer model directly or indirectly, therefore any queries that are defined in the customer model using the material number as a query attribute are displayed here. If you select to include, for example, the request CUSTOMERBYMATERIAL, a user can search for material by a material number and can then choose to display all the customers who have bought this material from within the search results.

  1. Select the node for which you want to select queries for related models.

  2. Choose the Related Queries tab.

    All the requests of models that include query attributes belonging to the selected node are displayed.

  3. Select the request(s) that you want to be displayed as related actions in the Search UI.

  4. Optional: You can use the Move function to change the sequence of the related requests on the user interface.

Defining Navigation Targets

You can define the option of jumping from the search results directly to the corresponding back-end system. The application using Embedded Search must support this function.

  1. Choose the Navigation Targets tab.

  2. Choose a UI technology for the navigation target that you want to create. You can choose from the following UI technologies:

    • WebClient UI

    • SAP GUI for HTML

    • SAP GUI

    • Web Dynpro

      Each of these UI technologies can be launched by an SAP NetWeaver Application Server or an SAP Enterprise Portal, for which you have to specify the associated server information. You can find the assignment of the UI technology to SAP NetWeaver Application Server or SAP Enterprise Portal in the name of the UI technology. For more information, see Maintaining UI Technologies.

    • General URL

      The General URL type is not assigned to a UI technology for a system. A general URL is always an available navigation technology, and is independent of the UI technologies activated for a system.

  3. To add a new navigation target, choose Add and specify an Operation ID.

    Note

    If applications provide more than one technology to launch an action, for example SAP GUI and Web Dynpro, you can group the various navigation targets to be configured by their function using the Operation ID.

    For more information about the sequence of the UI technologies and which UI technology is used as the primary UI technology by the configured navigation targets, see Maintaining UI Technologies.

    If you want to reuse an existing operation ID for a navigation target in another UI technology, proceed as follows:

    1. First, you choose an existing Operation ID.

    2. Choose another UI technology that the application supports.

    3. Specify the operation and other parameters for this UI technology as described below.

  4. Click the Operation field and enter an operation depending on the chosen UI technology.

    If you choose SAP GUI, this can be a transaction code, or if you choose General URL, a parameterized URL with attributes of the model node.

    For all other UI technologies, use the following URL syntax, consisting of prefix, static part, and suffix:

    • Prefix: In the format ${PROTOCOL}://${HOST}:${PORT}.

      The prefix contains variable information about the server that is stored in the configuration. At runtime, the variables are completed using the configured entries.

    • Static part: After the prefix, specify the static part of the URL, for example, /sap/bc/webdynpro/myapplication.

    • Suffix: After the static part, you can enter other runtime parameters in the form of variables, for example, ?sap-language=EN&Id=${CUSTOMER_ID}.

      These parameters are completed at runtime and must exist in the model node as a response attribute.

      You may also have to enter system information, for example, &system={SYS_ALIAS}.

      Example

      ${PROTOCOL}://${HOST}:${PORT}/sap/bc/webdynpro/myapplication?sap-language=EN&Id=${CUSTOMER_ID}

    Note

    You can obtain the URL for an operation in the following way:

    • For Web Dynpro applications: Start the application and copy the URL from the browser.

    • For portal applications: Search for the iView or page in the portal content and use the preview function to launch the URL required and copy it from the browser.

    • For launches in other applications: Use logging software to record the HTTP accesses when launching the application and analyze these.

    Parameter entries in the URL must be supported by the application.

    Example
    • If you choose SAP GUI: By entering the transaction code XD03 as the value for Operation for a customer model in an SAP system, you configure a jump to the SAP GUI screen to display customer master data.

    • If you choose SAP GUI: Enter the transaction code SE21 and specify PACKAGE=PBENSCREEN-PACKNAME in the attribute assignment table.

    • URL if you choose WebClient UI: ${PROTOCOL}://${HOST}:${PORT}/sap/bc/bsp/sap/it00/transition_parameter.htm?onInputProcessing(go)&firstName=${FIRST_NAME}&LASTNAME=${LAST_NAME}&streetandnumber={STREET}+{NUMBER}

    • URL if you choose Web Dynpro (Portal): ${PROTOCOL}://${HOST}:${PORT}/irj/servlet/prt/portal/prteventname/Navigate/prtroot/pcd!3aportal_content!2fevery_user!2fgeneral!2fdefaultDesktop!2fframeworkPages!2fframeworkpage!2fcom.sap.portal.innerpage!2fcom.sap.portal.contentarea?NavigationTarget=ROLES%3A%2F%2Fportal_content%2Fcom.sap.pct%2Fevery_user%2Fcom.sap.pct.erp.common.bp_folder%2Fcom.sap.pct.erp.common.roles%2Fcom.sap.pct.erp.common.erp_common%2Fcom.sap.pct.erp.common.lpd_start_wd_abap&ApplicationParameter=applid%3d%252FSREP%252FFI_GL_40_Q2+%26sap-wd-configId%3dWDK_REPORTING&System={SYS_ALIAS}&WebDynproApplication=powl&WebDynproConfiguration=&WebDynproNamespace=sap&CurrentWindowId=WID1227107726148&NavMode=1&TarTitle=Profit%20Center:%20Receivables%20(List)

    • URL if you choose General URL: You can enter a URL according to the schema http://www.test.com.using${MDMSRM_SUPPLIER} to allow the user to jump from the Search UI directly to a search engine by the name of Test to search for the name of the supplier in the search results.

  5. Click into the Description field and enter a description for the back-end operation.

  6. If you define several back-end operations, define the order in which the operations are to be displayed in the Search UI. The application using Embedded Search must support this function.

    Click into the Display Order column and enter the appropriate number. 1 means that the navigation target operation is at the top of the list, 2 is the second entry, and so on.

    Note

    Defining a display order number for a navigation target only makes sense for targets that are not defined as the primary navigation target, that means for which Object Link is not selected (see below).

  7. To define a primary navigation target, choose Object Link. The primary navigation target is the target that users are directed to when they click the link of the search result itself in the results list. You can only define one operation as the primary navigation target.

  8. Choose the Display or Change option in the Mode column to define whether the user is to be able to access the corresponding data in display or change mode, respectively.

  9. Only for SAPGUI transactions: Map the target attribute for the navigation to the back-end system.

    Here you configure the "jump" to go to a specific target. Normally, a transaction contains a starting selection screen where you are prompted to enter an object key value. To avoid the selection screen, you can define that the attribute value from the search results is passed on as the object key value for the corresponding attribute in the back-end system.

    1. Choose a back-end process for the UI technology SAP GUI in the area Details: Navigation Targets for Node <Node Name>.

    2. Choose Add in the Details: Attribute Mapping of Navigation Target area to insert a new row.

    3. In the dialog box, select a node attribute from the list.

    4. Click the Back-End Screen Field column and enter the Dynpro field name of the corresponding attribute in the back-end system.

  10. Once you have defined all required optional settings, choose Finish.

You can now create search object connectors based on this model. More information: Creating Search Object Connectors in Modelling