EnterpriseSearch Annotations

Scope and Definition

@Scope:[#VIEW, #TABLE_FUNCTION, #ENTITY] 
Annotation EnterpriseSearch
 {
   enabled : Boolean default true;
 };
@Scope:[#ELEMENT] 
Annotation EnterpriseSearch
 {
   expand : Boolean default true;

   filteringFacet : { default };
   defaultValueSuggestElement : true;
   usageMode : array of String(20) enum
   {
      ADVANCED_SEARCH = 'AdvancedSearch';
      AUTO_FACET = 'AutoFacet';
      SUGGESTION = 'Suggestion';
   };
   presentationMode : array of String(20) enum
   {
      DETAIL = 'Detail';
      HIDDEN = 'Hidden';
      IMAGE = 'Image';
      SUMMARY = 'Summary';
      THUMBNAIL = 'Thumbnail';
      TITLE = 'Title';
      NONE = 'None';
   };
   commonAttributes : array of String(100);
   snippets
   {
      enabled : Boolean default true;
      beginTag : String(128) default '<b>';
      endTag : String(128) default '<b>';
   };
   highlighted
   {
      enabled : Boolean default true;
      beginTag : String(128) default '<b>';
      endTag : String(128) default '<b>';
   };
 };

Usage

Annotation Meaning
EnterpriseSearch.enabled

Defines if a CDS view is generally relevant for search scenarios based on SAP HANA Enterprise Search.

Scope: #View

Evaluation Runtime (Engine): Interpreted by Enterprise Search

Values:

Value Description
Boolean (true, false)

Defines whether a CDS view is relevant for Enterprise Search or not. If it is set to true a search connector is created in Enterprise Search automatically.

Default: true

EnterpriseSearch.filteringFacet

Specifies that the element is to be considered as a request field which is used for facetted search (also named interactive navigation or guided navigation).

Scope: #Element

Evaluation Runtime (Engine): Interpreted by Enterprise Search

Values:

Value Description
{ default } Defines weather the element is to be considered as a request field in facetted search.

Default: { default }

EnterpriseSearch.defaultValueSuggestElement

Specifies that the element is to be considered for suggestions (also named type-ahead or auto-completion function).

Scope: #Element

Evaluation Runtime (Engine): Interpreted by Enterprise Search

Values:

Value Description
Boolean (true, false)

Defines weather the element is to be considered for suggestions.

Default: true