By default, the Agent Console uses TextSearch internally to search orders and customers.

It can be configured to use Repository Based Search instead of TextSearch by using the textSearch admin endpoint. This endpoint can be used to enable and disable TextSearch. When TextSearch is enabled, the Agent user interface uses TextSearch internally. When TextSearch is disabled, the Agent user interface uses Repository Based Search.

To enable TextSearch, issue a POST request to the textSearch endpoint as follows:

POST /ccadmin/v1/merchant/textSearch

{
  "enable": true,
  "scheduledJobs": [
    {
      "scheduledJobName": "orderIncrementalIndexingSchedule",
      "scheduleType": "periodic",
      "schedule": {
        "period": 20000
      }
    },
    {
      "scheduledJobName": "profileIncrementalIndexingSchedule",
      "scheduleType": "periodic",
      "schedule": {
        "period": 20000
      }
    },
    {
      "scheduledJobName": "orderOptimizationSchedule",
      "scheduleType": "calendar",
      "schedule": {
        "occurrenceInDay": 2
      }
    },
    {
      "scheduledJobName": "profileOptimizationSchedule",
      "scheduleType": "calendar",
      "schedule": {
        "occurrenceInDay": 1
      }
    }
  ]
}

The scheduledJobs orderIncrementalIndexingSchedule and profileIncrementalIndexingSchedule are responsible for ensuring that new customers and orders and the latest modifications made to these entities are searchable.

Determine an appropriate schedule for these jobs based on an acceptable interval to search for a customer or order after it is created or modified. Since TextSearch is enabled out of the box, these jobs are configured to run every 20 seconds by default.

The scheduledJobs orderOptimizationSchedule and profileOptimizationSchedule are responsible for improving search performance by running an optimization service.

Determine an appropriate schedule for these jobs based on how search performance degrades with the increase in the rate of updates and creations of orders and customers. It is recommended that a schedule frequency of not more than once per day be established.

After issuing a request to enable TextSearch, an offline setup process is initiated which may take a few minutes or more. The setup status can be queried by issuing a GET request to the same endpoint.

If TextSearch was already enabled, issuing another request to enable TextSearch updates the scheduledJobs with the new schedule settings and does not initiate any offline setup process.

To disable TextSearch, issue a POST request to the textSearch endpoint as follows:

POST /ccadmin/v1/merchant/textSearch

{
  "enable": false
}

For more details on this endpoint, refer to the Agent REST API. For more information on how to provide schedule settings, refer to the Configure the scheduled order service section in Extending Oracle Commerce Cloud.


Copyright © 1997, 2018 Oracle and/or its affiliates. All rights reserved. Legal Notices