Adding a Boost-Bury Record editor

The Boost-Bury Record editor enables a content administrator to specify certain records to display either at the top or bottom of the list of results for a page.

The Boost-Bury Record editor uses the Select Records dialog to enable the content administrator to specify either an ordered list of record IDs or a set of refinements that define the set of records to be boosted or buried.

Note

The Boost-Bury Record editor communicates with the MDEX Engine. In order to enable the editor, ensure that you have enabled communication between Experience Manager and the MDEX Engine.

To add a Boost-Bury Record editor:

  1. In typeInfo, insert boostStrata and buryStrata with property types of list. 

    "typeInfo": {
        "boostStrata": {"@propertyType": "List"},
        "buryStrata": {"@propertyType": "List"}
    }

  2. Insert an editors/BoostBuryRecordEditor element within editors/DefaultEditorPanel.

  3. Specify additional attributes for the editor:

    AttributeDescription
    propertyName Required. The name of the item property that represents the records to be boosted to the top of the results. This property must be declared in the same template as the Record Stratification editor.
    buryProperty Required. The name of the list property that represents the records to be buried at the bottom of the results. This property must be declared in the same template as the Record Stratification editor.
     {
                "editor": "editors/BoostBuryRecordEditor",
                "buryProperty": "buryStrata",
                "propertyName": "boostStrata",
                "label": "${property.boostBury.label}"
            },

The following shows an example of a template that includes a Boost-Bury Record editor: 

{
    "@description": "${template.description}",
    "@group": "MainContent",
    "ecr:createDate": "2016-09-12T17:33:58.542+05:30",
    "@thumbnailUrl": "thumbnail.png",
    "ecr:type": "template",
    "defaultContentItem": {
        "@name": "Results List",
        "relRankStrategy": "",
        "recordsPerPage": "10",
        "sortOption": {
            "@class": "com.endeca.infront.navigation.model.SortOption",
            "label": "Most Sales",
            "sorts": [{
                "@class": "com.endeca.infront.navigation.model.SortSpec",
                "key": "product.analytics.total_sales",
                "descending": false
            }]
        }
    },
    "editorPanel": {
        "editor": "editors/DefaultEditorPanel",
        "children": [
            {
                "editor": "editors/BoostBuryRecordEditor",
                "buryProperty": "buryStrata",
                "propertyName": "boostStrata",
                "label": "${property.boostBury.label}"
            },
<!-- additional elements omitted from this example -->
                ]
    },
    "typeInfo": {
        "boostStrata": {"@propertyType": "List"},
        "buryStrata": {"@propertyType": "List"},
        "recordsPerPage": {"@propertyType": "String"},
        "relRankStrategy": {"@propertyType": "String"},
        "sortOption": {"@propertyType": "Item"}
    }
}

Related links

The boost-bury record editor must be configured with a path to a data service.

Below is the configuration for the boost-bury editor in the editor JSON file for the Discover Electronics reference application, located at <app dir>\config\import\editors\BoostBuryRecordEditor\_.json: 

{
    "ecr:type":"editor",
    "config" : {
       "resourcePath": "/configuration/tools/xmgr/services/endecaBrowserService.json"
     }
}

Copyright © Legal Notices