Ansicht
Dokumentation

CRM_IU_IC_FREETXTSCH - Define Free Text Search Profiles

CPI1466 during Backup   SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up  
This documentation is copyright by SAP AG.

Within the Interaction Center of SAP S/4HANA Utilities for customer management, when identifying a business partner or a premise, you have to be able to quickly search for a business partner or a premise. With a single search field and suggestion list, you can now enter any information for the business partner or premise to identify the correct object. The suggestion list is proposed as soon as you have entered a minimum number of characters. You can also view the business partner or premise information by selecting one of the rows in the suggestion list. In addition, it is possible to use the NarrowBy function to limit the searched fields to ensure even more accurate results.

The Customizing of the Free Text Search function is grouped by profile so that it can be reused easily in any context, and this also allows it to be integrated into any application area. For a Utilities application, the profile is assigned to the functional profile IU_HSSof the ICWebClient role.

The Customizing is divided into four main parts:

• Data Provider: defines the source of data for performing the query or the retrieval of information for a specific object (business partner or premise). It is represented by a class which is extended from the abstract class CL_CRM_IU_HSS_DP_ABS. This means that the Data Provider can request data from any Data Source (HANA DB, Enterprise Search or by a simple SELECTstatement in the database). If the Data Provider uses Enterprise Search, the implementation class can be extended from the existing abstract class CL_CRM_IU_HSS_DP_ES_ABS, which contains the necessary built-in methods for Enterprise Search.

• NarrowBy: defines all of the different groupings of search fields. Each grouping consists of a NarrowBy entry which ensures a more accurate suggestion list by limiting active search fields. If Enterprise Search is used, each NarrowBy may have its own Enterprise Search model. If the model is not specified for the NarrowBy, then the model specified in Data Provider is used instead.

• Search Fields for NarrowBy: defines the search fields which will be used when the NarrowBy entry is selected. If Enterprise Search is used, then the available search fields will be the ones provided by the Model as request attributes.

• OData Service: defines the service name for SAP Gateway, the external names for the suggestion list and for the quick view of the object. The Data Providers are assigned to the OData services that are used for the suggestion list and the quick view. With the OData service definition, the Free Text Search function determines which URL for OData service to retrieve the data from and at the same time, the OData service layer determines which Data Provider must be used to retrieve the data.

• Suggestion List Fields Group: defines the group of OData fields for the suggestion list. The fields group can later on be assigned to a NarrowBy.

• Suggestion List Fields Mapping: defines the mapping between the OData fields and the Data Provider fields. It is possible to assign several Data Provider fields to one OData field. Whenever this is done, the sequence column needs to be filled to specify in what order these fields will be concatenated for the given OData field.

Each mapping can also have text before and/or after the Data Provider field. The text can consist of one of the following: a single character, a string, a new line or an OTR text. Whenever a comma is used before or after as text then it will be automatically removed accordingly for an enumeration (such as a group of several telephone numbers) to ensure that no leading or trailing commas are displayed. For a new line or an OTR text, use the following notation: and . For the OTR notation, enter the OTR Alias between the parentheses. These options are available in the F4 help.

The OData fields are the ones which are enumerated in the Gateway configuration (transaction: SEGW). The field labels for each OData attribute can be modified in the same transaction.

Each field mapping can also have a type. The type can consist of one of the following:

- Always shown: The specified data provider field data will be always mapped to the OData field.

- Show when found: The specified data provider field data will be mapped to the OData field only if a search term is found in the data provider field data.

- Show when nothing found: When the search term is not found in any data provider field where the field type is "Show when found", then the specified data provider field data will be mapped to the OData field.

• Quick View Fields Mapping: defines the mapping between the OData fields and the Data Provider fields. It is possible to assign several Data Provider fields to one OData field. Whenever this is done, the sequence column needs to be filled to specify in what order these fields will be concatenated for the given OData field.

,,

Each mapping can also have text before and/or after the Data Provider field. The text can consist of one of the following: a single character, a string, a new line or an OTR text. Whenever a comma is used before or after as text then it will be automatically removed accordingly for an enumeration (such as a group of several telephone numbers) to ensure that no leading or trailing commas are displayed. For a new line or an OTR text, use the following notation: and . For the OTR notation, enter the OTR Alias between the parentheses. These options are available in the F4 help.

,,

The OData fields are the ones which are enumerated in the Gateway configuration (transaction: SEGW). The field labels for each OData attribute can be modified in the same transaction.

• Search Object: defines which search objects (business partner, premise) could be used in a free text search. For each search object, different search attributes (fuzzy percentage) and UI attributes (icon, quick view enabling, max hits and so on) are also defined. The search object is associated with an OData service that has already been customized.

• Suggestion List Fields Group Assignment: assigns the fields group to a NarrowBy. This means that each NarrowBy will have its own group of OData fields to be used to display on the suggestion list.

• Suggestion List Columns: defines the OData field to be used for each result column on the suggestion list. The order of the result column can be specified by using the sequence number. For each column, the width as a percentage can be also specified.

• Quick View Set: defines all the groupings of attributes into different Quick View sets. Details of a particular search object can be viewed in small sets. The order of the Quick View Sets can be specified using the sequence number. For each search object, when the UI displays the quick view data, the quick view set is equivalent to a page in the quick view area.

• Quick View Attributes: defines all the OData attributes that should be provided for a particular Quick View Set. The order of the attributes can be set using the sequence number. From a UI perspective, the quick view attribute will be displayed as a pair: a label with a value. The label of each quick view attribute is defined in the Gateway Service Builder (transaction SEGW) under the project CRM_IU_HSS.

• Profile: groups the desired search objects together. In the profile, it is possible to indicate if the Free Text Search feature is activated or if it should be used as a default on the Identification screen.

Before performing the Customizing for Free Text Search, the following prerequisites must be fulfilled:

• Activate the service CRM_IU_HSS_SRV with SAP Gateway transaction /IWFND/MAINT_SERVICE

• Activate the service CRM_IU_HSS_UI5with Internet Communication Framework transaction SICF

• On the system, create a connector for Enterprise Search models CRM_IU_HSS_BP (business partner) and CRM_IU_HSS_PREMISE(premise) with Enterprise Search transaction ESH_COCKPIT

• On the Utilities system, create a connector for Enterprise Search models ISU_CRM_BP_PR_DOC (print document), ISU_CRM_PREMISE_DEV (device) and ISU_CRM_PREMISE_OWN (premise owner) with Enterprise Search transaction ESH_COCKPIT

• System setup for Free Text Search (see Set Up Guide: Free Text Search in the Interaction Center on the SAP Service Marketplace at http://service.sap.com under Industries and Solutions-> Utilities-> SAP for Utilities - Product Information-> SAP CRM for Utilities-> Cookbooks & Guidelines).

The default profile UTIL_DEFAULThas been assigned to the IC WebClient roles UTIL_ICand UTIL_IC_REG. The profile UTIL_DEFAULTsupports two search objects: business partner and premise, which use the Data Providers with Enterprise Search for business partner and premise. They use the implementation classes CL_CRM_IU_HSS_DP_ES_PARTNER and CL_CRM_IU_HSS_DP_ES_PREMISE.

Depending on the business process, you can perform the Customizing of Free Text Search by doing the following:

Step 1: Define Data Providers

You can customize the Data Provider for your business needs by enhancing the Enterprise Search model or simply implementing a new Data Provider class to get data from another data source than Enterprise Search. If you need to implement a new Data Provider, this class must be extended from the abstract classes CL_CRM_IU_HSS_DP_ABS and CL_CRM_IU_HSS_DP_ES_ABS.

Step 2: Define the NarrowBy Entries

Various NarrowBy entries can be provided to ensure more accurate suggestion list results.

Step 3: Assign Search Fields to Narrow By Entries

For each NarrowBy entry, a set of Data Provider fields are selected that determine which fields will be searched. For example, Business Partner Address could be a NarrowBy entry and only the address-related search fields will be used (such as house number, street name, city name, and so on). This way, if you search for a street name using the NarrowBy option, you ensure that you don't receive any suggestions where, for example, the business partner's last name matches the searched street name. The available fields are the ones which are specified in the Enterprise Search Model (transaction ESH_MODELER) as request attributes if the data provider uses Enterprise Search. If the data provider does not use Enterprise Search, you can specify the search field names and during the search process, those fields will be passed to the data provider method SEARCH. Note that there is no validation of the field name while you are making the Customizing settings unless your data provider uses Enterprise Search.

Step 4: Define OData Services

The OData service requires a Data Provider for a suggestion list and for a quick view as well as entity set name in the resource path of the OData service. The name of the ICF service is also required to access the OData service.

Step 5: Map the OData fields to Data Provider Fields

The link between the OData fields and the Data Provider fields is created in this step.

Step 6: Define Search Objects

Each search object can have an external name, so it can be used for subsequent processes. On the Identification screen, the external name BuilHeader is used for business partners and the external name Premiseis used for premises. These external names identify the search object in the IC WebClient and the confirmation of the object can be processed. You must assign the OData service to each search object, and also set the fuzzy percentage for the search.

Besides these Customizing settings, you can also customize certain UI attributes, for example, quick view enabling, maximum items in suggestion list, width percentage of suggestion list, icons, and so on.

Step 7: Assign Column Fields to Each Narrow By

For each Narrow By, you can assign a suggestion list fields group and define the OData field column to be displayed on the suggestion list. The order will be defined by the sequence number and it's also possible to hide undesired columns. The width of the column is specified as a percentage.

Step 8: Define Quick View Sets

Each Search Object needs at least one Quick View Set if the Quick View is enabled. Each Quick View Set will be associated to one page in the Quick View. The order will be defined by the sequence number and it's also possible to hide undesired views.

Step 9: Assign Fields to Each Quick View

The desired OData fields to be displayed for each Quick View Set are assigned here. Each Quick View Set can group fields which are related to each other. The order will be defined by the sequence number and it's also possible to hide undesired attributes.

Step 10: Define Profile

You can set the profile as active or inactive. If the profile is set as inactive on the Identification screen, it is not possible to use Free Text Search. In the profile, Free Text Search can also be set to be used as a default on the Identification screen.

Step 11: Assign Search Object to Profile

Each search object identified previously, can be assigned to the profile.

In order to use the Free Text Search profile in a specific ICWebClient role, the Free Text Search profile must be assigned to the function profile IU_HSS of the desired role.

You can refer to the default profile UTIL_DEFAULT as an example.

CPI1466 during Backup   ROGBILLS - Synchronize billing plans  
This documentation is copyright by SAP AG.

Length: 16938 Date: 20240523 Time: 173750     sap01-206 ( 327 ms )