/AWS1/IF_KND=>CREATEFEATUREDRESULTSSET()

About CreateFeaturedResultsSet

Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.

You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.

Method Signature

METHODS /AWS1/IF_KND~CREATEFEATUREDRESULTSSET
  IMPORTING
    !IV_INDEXID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IV_FEATUREDRESULTSSETNAME TYPE /AWS1/KNDFEATDRESULTSSETNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/KNDFEATDRESULTSSETDESC OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/KNDCLIENTTOKENNAME OPTIONAL
    !IV_STATUS TYPE /AWS1/KNDFEATDRESULTSSETSTATUS OPTIONAL
    !IT_QUERYTEXTS TYPE /AWS1/CL_KNDQUERYTEXTLIST_W=>TT_QUERYTEXTLIST OPTIONAL
    !IT_FEATUREDDOCUMENTS TYPE /AWS1/CL_KNDFEATUREDDOCUMENT=>TT_FEATUREDDOCUMENTLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_KNDTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndcreateftdrsssetrsp
  RAISING
    /AWS1/CX_KNDACCESSDENIEDEX
    /AWS1/CX_KNDCONFLICTEXCEPTION
    /AWS1/CX_KNDFTDRSSCONFLICTEX
    /AWS1/CX_KNDINTERNALSERVEREX
    /AWS1/CX_KNDRESOURCENOTFOUNDEX
    /AWS1/CX_KNDTHROTTLINGEX
    /AWS1/CX_KNDVALIDATIONEX
    /AWS1/CX_KNDCLIENTEXC
    /AWS1/CX_KNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index that you want to use for featuring results.

iv_featuredresultssetname TYPE /AWS1/KNDFEATDRESULTSSETNAME /AWS1/KNDFEATDRESULTSSETNAME

A name for the set of featured results.

Optional arguments:

iv_description TYPE /AWS1/KNDFEATDRESULTSSETDESC /AWS1/KNDFEATDRESULTSSETDESC

A description for the set of featured results.

iv_clienttoken TYPE /AWS1/KNDCLIENTTOKENNAME /AWS1/KNDCLIENTTOKENNAME

A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

iv_status TYPE /AWS1/KNDFEATDRESULTSSETSTATUS /AWS1/KNDFEATDRESULTSSETSTATUS

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

it_querytexts TYPE /AWS1/CL_KNDQUERYTEXTLIST_W=>TT_QUERYTEXTLIST TT_QUERYTEXTLIST

A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

it_featureddocuments TYPE /AWS1/CL_KNDFEATUREDDOCUMENT=>TT_FEATUREDDOCUMENTLIST TT_FEATUREDDOCUMENTLIST

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

it_tags TYPE /AWS1/CL_KNDTAG=>TT_TAGLIST TT_TAGLIST

A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

RETURNING

oo_output TYPE REF TO /aws1/cl_kndcreateftdrsssetrsp /AWS1/CL_KNDCREATEFTDRSSSETRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createfeaturedresultsset(
  it_featureddocuments = VALUE /aws1/cl_kndfeatureddocument=>tt_featureddocumentlist(
    ( new /aws1/cl_kndfeatureddocument( |string| ) )
  )
  it_querytexts = VALUE /aws1/cl_kndquerytextlist_w=>tt_querytextlist(
    ( new /aws1/cl_kndquerytextlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_kndtag=>tt_taglist(
    (
      new /aws1/cl_kndtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_featuredresultssetname = |string|
  iv_indexid = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_featuredresultsset = lo_result->get_featuredresultsset( ).
  IF lo_featuredresultsset IS NOT INITIAL.
    lv_featuredresultssetid = lo_featuredresultsset->get_featuredresultssetid( ).
    lv_featuredresultssetname = lo_featuredresultsset->get_featuredresultssetname( ).
    lv_featuredresultssetdescr = lo_featuredresultsset->get_description( ).
    lv_featuredresultssetstatu = lo_featuredresultsset->get_status( ).
    LOOP AT lo_featuredresultsset->get_querytexts( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_querytext = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_featuredresultsset->get_featureddocuments( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_documentid = lo_row_3->get_id( ).
      ENDIF.
    ENDLOOP.
    lv_long = lo_featuredresultsset->get_lastupdatedtimestamp( ).
    lv_long = lo_featuredresultsset->get_creationtimestamp( ).
  ENDIF.
ENDIF.