Error Modules

Error modules typically appear when a user searches for non-existing content or when there is a server fault. The following illustration is an example of an error module.

../../../_images/error-example.svg

The previous illustration has three elements: a search field, a title, and a description.

You can create error modules at the global, site, and section levels of the Content Hierarchy. All assets you create inherit the error module from the nearest available level in the content hierarchy.

In the following procedure, steps 6–8 are optional.

  1. Under Module Placement, scroll down to the module’s placement (Above, Aside, or Below). For an illustration of these positions, see the diagram in Modules.

  2. From the list box, select Add After. For an explanation of the possible selections for module placement, see Module Placement.

  3. From the Add drop-down list, select Error Module. An Error Module form appears.

  4. In the Title field, enter a title.

  5. In the Description field, enter a description. For an explanation of the buttons on this field’s toolbar, see Rich Text Editor. Compose a helpful message that explains the source of the error and possible recovery actions the user can perform.

  6. Optional Add a button that opens another page by doing the following:

    1. Click Add Button. A Button form appears.

    2. In the Text field, enter the label that appears on the button.

    3. Define the button’s link by doing the following:

      1. From the Link list, select one of the following:

        • Internal—The promoted item is part of your Brightspot project.
        • External—The promoted item is at a URL external to your Brightspot project.
      2. In the Main tab, fill out fields. The available fields depend on your choice for type of link in the previous step.

        ../../../_images/freeform-main.png
      3. In the Advanced tab, do the following:

        1. (For internally linked content only) In the Anchor field, type the name of an internal anchor in the linked item. When rendering the freeform module, Brightspot inserts the link as http://domain.com/page.html#anchor.
        2. From the Target drop-down list, select one of the following:
          • Same Window/Tab—The target item appears in the current browser window or tab.
          • New Window/Tab—The target item appears in a new browser window or tab.
        3. Under Attributes, click Add Attribute and add a name and value of HTML attributes applied to this freeform. Repeat to add additional attributes.
        ../../../_images/freeform-advanced.png
  7. Optional Add a list that contains links to items pertaining to the error by doing the following:

    1. From Link List, select Set. A form appears.
    2. In the Title field, enter a title.
    3. In the Description field, enter text as described in Rich Text. Compose a short message that introduces the links.
    4. Add items to the list. For a description of creating lists, see Lists.
    5. Depending on your current theme, there is an Overrides tab with additional fields you can use to further define the module.
  8. Optional From Search, select a search item.

    Your form looks similar to the following:

    ../../../_images/error-module-form.png
  9. Click Publish.