Adding a Dimension Value Boost-Bury editor

The boost-bury editor enables a content administrator to specify certain dimension values to display either at the top or bottom of the list of refinements for a particular dimension.

In order to enable a Dimension Value Boost-Bury editor, the cartridge template must include a dimensionId property with an associated editor or a default value. This specifies the dimension to which the boost-bury editor applies.

Note

The Dimension Value Boost-Bury editor makes use of an auto-suggest dimension search component to enable the content administrator to quickly find the relevant dimension values. In order for this component to display partial matches as the user types in the search box, ensure that wildcard search is enabled for dimension searches in your MDEX Engine configuration.

To add a Dimension Value Boost-Bury editor:

  1. Insert an editors/BoostBuryEditor element within editors/DefaultEditorPanel.

  2. Specify additional attributes for the editor:

    AttributeDescription
    propertyName Required. The name of the list property that represents the list of dimension values to be boosted to the top of the list of refinements. This property must be declared in the same template as the boost-bury editor.
    dimensionId Required. The ID of the dimension that contains the dimension refinements to boost or bury.
    boostProperty Required. The name of the list property that represents the list of dimension values to be boosted to the top of the refinement list. This property must be declared in the same template as the boost-bury editor.
    buryProperty Required. The name of the list property that represents the list of dimension values to be buried at the bottom of the list of refinements. This property must be declared in the same template as the boost-bury editor.
    enabled If set to false, this attribute makes the property read-only so that the value of the property displays in the Content Details Panel in Experience Manager, but cannot be edited. Use this option only if you specify a default value for the boostList and buryList properties. Editors are enabled by default.

The following shows an example of a template that includes a dimension value boost-bury editor: 

{
    "@description": "${template.description}",
    "@group": "Navigation",
    "ecr:createDate": "2016-09-12T17:33:58.404+05:30",
    "@thumbnailUrl": "thumbnail.jpg",
    "ecr:type": "template",
    "defaultContentItem": {
        "lessLinkText": "Show Less Refinements...",
        "numRefinements": "10",
        "@name": "Dimension Navigation",
        "dimensionId": "",
        "moreLinkText": "Show More Refinements...",
        "maxNumRefinements": "200",
        "sort": "default",
        "showMoreLink": false,
        "dimensionName": ""    },
    "editorPanel": {
        "editor": "editors/DefaultEditorPanel",
        "children": [
<!-- additional elements omitted from this example -->
            {
                "editor": "editors/BoostBuryEditor",
                "buryProperty": "buryRefinements",
                "propertyName": "boostRefinements",
                "label": "${property.boostBury.label}",
                "dimensionIdProperty": "dimensionId",
                "enabled": true
            },
<!-- additional elements omitted from this example -->
            ]
        },
    "typeInfo": {
        "boostRefinements": {"@propertyType": "List"},
        "buryRefinements": {"@propertyType": "List"},
        "dimensionId": {"@propertyType": "String"},
        "dimensionName": {"@propertyType": "String"},
        "lessLinkText": {"@propertyType": "String"},
        "maxNumRefinements": {"@propertyType": "String"},
        "moreLinkText": {"@propertyType": "String"},
        "numRefinements": {"@propertyType": "String"},
        "showMoreLink": {"@propertyType": "Boolean"},
        "sort": {"@propertyType": "String"}
    }
}

Copyright © Legal Notices