Adding a Guided Navigation editor

The Guided Navigation editor enables a content administrator to quickly create a navigation menu through the use of the Generate Guided Navigation wizard.

Note

The Guided Navigation 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.

A content administrator can use the Generate Guided Navigation button to trigger the Generate Guided Navigation wizard. The wizard allows them to select and order a set of dimensions to add as Refinement Menu cartridges. Alternately, they can choose to add, order, and configure the cartridges manually.

To add a Guided Navigation editor:

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

  2. Set a propertyName attribute on the editors/GuidedNavigationEditor element.

    This must be set to the name of the ContentItemList property that represents the list of Refinement Menu content items. The property must be declared in the same template.

  3. Insert an contentItemMapping element within the editor.

  4. Map the content item name to the dimension property that should populate it.

    This determines the name of the Refinement Menu content items created by the Generate Guided Navigation wizard.

    1. Include a names element within contentItemMapping: 

      "contentItemMapping": {
                "names": [],
            }

    2. Specify the dimension property to use for the content item name in a dimensionProperty attribute, and specify the dimension name as a fallback value.

      The Generate Guided Navigation wizard uses the first non-null value when naming a newly-created content item. 

      "contentItemMapping": {
                "names": [
                    {"dimensionProperty": "display_name"},
                    {"dimensionProperty": "endeca:name"}
                ],
            )

  5. Map the dimensionName and dimensionID properties to the dimension properties that populate them: 

    "propertys": [
                    { 
                       "dimensionProperty": "endeca:name",
                        "name": "dimensionName"
                    },
                    { 
                       "dimensionProperty": "endeca:identifier",
                        "name": "dimensionId"
                    }
                ]

The following shows an example of a template that includes a guided navigation editor: 

{
    "@description": "${template.description}",
    "@group": "SecondaryContent",
    "ecr:createDate": "2016-09-12T17:33:57.044+05:30",
    "@thumbnailUrl": "thumbnail.png",
    "ecr:type": "template",
    "defaultContentItem": {"@name": "Navigation Container"},
    "editorPanel": {
        "editor": "editors/DefaultEditorPanel",
        "children": [{
            "editor": "editors/GuidedNavigationEditor",
            "propertyName": "navigation",
            "contentItemMapping": {
                "names": [
                    {"dimensionProperty": "display_name"},
                    {"dimensionProperty": "endeca:name"}
                ],
                "propertys": [
                    { 
                       "dimensionProperty": "endeca:name",
                        "name": "dimensionName"
                    },
                    { 
                       "dimensionProperty": "endeca:identifier",
                        "name": "dimensionId"
                    }
                ]
            }
        }]
    },
    "typeInfo": {"navigation": {
        "@propertyType": "ContentItemList",
        "@group": "Navigation"
    }}
}

Copyright © Legal Notices