Show TOC

Using the Search and Analytics ModelerLocate this document in the navigation structure

Use

The search and analytics modeler allows you to extend the search object connector models provided by SAP to meet your requirements. You can also create new models to connect additional search objects to your search. To create models for additional search objects, import the metadata and model the corresponding search BO object according to your requirements.

You access the modeler through the Administration Cockpit.

Structure

The modeler overview screen has the following layout:

The control bar and the overview are always displayed. The details area is only displayed once you select a model in the overview area.

Language Control

In the Model Language field, you can select the language in which language-specific content in model fields is to be displayed and maintained.

Control Bar

This section contains the buttons for executing the following actions:

Pushbutton/Command

Function

Import

You use this button to import models and software components from a SAP Business Suite application.

Create

You use this button to create a new search object connector model.

Copy

You use this button to copy an existing search object connector model.

The button is active when you select a search object connector model in the overview area.

Display

You use this button to open an existing search object connector model in write-protect mode in the roadmap. You cannot change the model.

Edit

You use this button to change an existing search object connector model. This can be a model that you have created or a model delivered by SAP.

The button is active only when you select a search object connector model in the overview area.

Delete

You use this button to delete an existing search object connector model. This button is active when you select a search object connector model that you have created or changed.

Check

This button opens a dialog box, which shows the quality check results for the selected software components or the model. You can also start the check using the command in the Actions menu.

Software Components

This pushbutton opens a dialog box containing the following commands:

  • Manage Software Components

    This button opens a dialog in which you can create and delete software components.

    Software components are used to organize models.

  • Embed Software Components

    Select the software component in which you want to embed further software components and their models and choose this pushbutton. In the selection dialog, choose the software component to include.

    The chosen software components are added to your software component as a copy with all properties. Properties that you have not set in the original version can be set in the copy. Properties that you have set in the original version cannot be changed in the copy. If changes are made to the original version , these are transferred to all included copies. Changes to a copy apply only to that copy, not to the original version or other copies.

  • Where-Used List

    Shows where the selected software components are used.

  • Export to File (XML)

    Using this function, you can export a software component as an XML file.

    Select the download function and save the XML file by choosing Save in your browser. You can implement the exported software component in other systems for modeling by choosing Start of the navigation path Import Next navigation step Import from File (XML) End of the navigation path.

    The function is intended for exchanging prototypes in development projects and should not be used in productive systems.

Actions

Includes the commands listed in the table below.

Show/Hide Authorization Model

You can use this link to show or hide authorization models in the overview area. Once you have shown them, you can change the authorization models, for example.

Search Field and Search

Enter the name or part of the name of a software component or a model in the search field to go more quickly to the required object.

Administration Cockpit

This link takes you to the administration cockpit.

The Actions button contains the following entries:

Action

Function

Quality Check of Model

This action opens a new window in which you can run a model check.

In the Selection Criteria area, you can restrict the check to specific models or software components by using the categories "users", "software components" and "models".

To check all models of all software components, select the field All Software Components in the category software components.

In the Available Checks section, you can select the checks you want to be performed.

To start the check, choose Execute Check.

If you choose List Models, you can display a list of the models according to the selection criteria and download it as a model list.

Once you have started the check, the result of the check is displayed. You can sort the content of the result list either by check criteria (for example, by user ID), by evaluation, or by model. For each result, a detail view is displayed below the table, containing error details and notes for troubleshooting.

You can define an entry as an exception, so that it is no longer displayed as an error in further checks. To do this, enter a text for the exception and choose Exempt from Check.

Display Model Data

This view is active by default. Here, you can change content. If you have selected the Display Connector Data action, you can use it to switch back to the standard view.

Display Connector Data

Shows objects that are currently used by active search object connectors. This view is read-only. You can check the status of search object connectors in the administration cockpit.

To switch back to the standard view with the models, choose Display Model Data.

Version Management

Here you can find a list of the models after an upgrade, update, or correction of search models by SAP. If software components are marked in red, open a customer message on the support component of the transported model.

Copy Software Component

This pushbutton is available only in a system with a customizing client. You use this function to generate a copy of a software component and transfer it to other clients.

Resolve Conflicts

More information: Resolving Naming Conflicts

Create Classification Model

Note

This function is available for SAP Business Suite applications to allow them to implement the classification search.

You can use this command to generate the models that TREX requires for a classification search.

Specify the following parameters:

Model Name: Enter a name for the classification model.

Model to Be Classified: Select the model to be classified.

Node to Be Classified: Select the node to be classified for the selected model.

Key Attribute: Select the attribute that contains the key for the object to be classified.

To create the classification model, choose OK. The system then creates the technical models that TREX requires (classification model and, if they do not already exist, property model and property-data-type model).

Create Connector

You use this button to create a new search object connector model.

Display Switch Assignment

This function is available only for SAP and is part of the SAP Switch Framework.

Overview Area

The Overview area contains the following columns:

  • Selection column

    Click the relevant row in this column to select a software component or search object connector model.

  • Software Component/Model

    This column displays the available search object connector models sorted by product version.

    The available models in a software component are displayed in a tree-like structure. To see the models that belong to a specific software component, you must expand the corresponding nodes by clicking them.

  • Description

    In this column, you can enter descriptions for the models you create. Click into the field in the relevant row and enter your description. The description of a software component can be changed in the software component dialog.

  • Type

    In this column, you can see whether the row refers to a software component or search object connector model. You can display the following models: Models for business objects, models for technical objects, models for authorization objects, and virtual models. The fields of the column are read-only.

  • Name in Back End:

    This column contains the name of the model as used in the back-end system.

  • Switched

    Specifies whether or not a model with the Switch Assignment function has been activated using the SAP Switch Framework.

Note

The modeler is subject to authorization checks at the software component level and search object connector model level. If you log on with limited access rights, the overview area may not contain any entries or may automatically switch to display mode.

Details Area

The Details area contains the following columns:

  • Node

    This column displays the available nodes of the model.

  • Node Description

    This column displays the node descriptions, if available.

  • Assignment

    This column displays the foreign keys, if there are relations to other models.

Modeling Roadmap

Once you select a created model and choose Edit, the display changes to show a roadmap for modeling the model. You can save your settings at various points within this roadmap. This allows you to stop working on a current modeling project and resume work later.

While working through the steps in the roadmap, the following buttons are available for navigation:

  • Previous: If you choose Back, you go to the previous step in the roadmap. The settings made in the current step are retained, but not saved to the database.

  • Next: If you choose Next, you go to the next step in the roadmap. The settings made in the current step are retained, but not saved to the database.

  • Cancel: Choosing Cancel discards the changes you have made since you last chose Save and takes you back to the modeler entry screen or to the administration cockpit.

  • Finish: Choosing Finish saves your entries and takes you back to the modeler entry screen or to the administration cockpit.

  • Save: Choosing Save saves your entries in the database and you stay on the current screen.