How to implement Search using ElasticSearch?

To make use of features (e.g. full-text search) provided by ElasticSearch and it’s extension/plugin ElasticSearchBundle created specifically for Superdesk Publisher, you need to do the following steps.

Create a new Route

You can create a new route using admin interface as described in Create new route with extension (example: feed/sitemap.rss) section. In this example the created route under which we will place search will be named: search.

Create a template file

Example search template which loads search and its results when filtered by criteria:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# ../view/search.html.twig
<form name="filter" method="get">
    <input type="search" id="filter_search" name="q">
</form>

{% set itemsPerPage, currentPage = 8, app.request.get('page', 1) %}
{% set start = ((currentPage - 1) * itemsPerPage) %}

{% gimmelist article from searchResults|limit(app.request.get('limit', 10))|order(app.request.get('field', 'publishedAt'), app.request.get('direction', 'desc')) with {
    term: app.request.get('q', ''),
    page: app.request.get('page', 1),
    routes: app.request.get('route', []),
    term: app.request.get('q', ''),
    publishedBefore: app.request.get('publishedBefore'),
    publishedAfter: app.request.get('publishedAfter'),
    publishedAt: app.request.get('publishedAt'),
    sources: app.request.get('source', []),
    authors: app.request.get('author', []),
    statuses: app.request.get('status', []),
    metadata: app.request.get('metadata', []),
} %}
    <h4>{{ article.title }}</h4>
    <p>{{ article.lead }}</p>

{% if loop.last  %}
    {% include '_tpl/pagination.html.twig' with {
    currentFilters: {}|merge(app.request.query.all()),
    currentPage: currentPage,
    paginationPath: gimme.route,
    lastPage: (loop.totalLength/itemsPerPage)|round(0, 'ceil')
    } only %}

    Showing {{ searchResults|length }} out of {{ loop.totalLength }} articles.
{% endif %}
{% endgimmelist %}

<a href="search?route[]=50">Business</a>
<a href="search?route[]=49">Politics</a>

Alternatively, to built-in order function, you can also use sort: app.request.get('sort', []), parameter to sort by different fields and directions which needs to be passed directly to the with statement.

Available search criteria:

Based on the above template.