Document Type Editor - Bloomreach Experience - Headless Digital Experience Platform

Document Type Editor

Introduction

The brX Content module includes a WYSIWYG Document Type Editor which allows web developers to create and modify document types to be used in their projects. A document type defines a type's data structure as well as the editing template used by authors to create and modify documents of that type.

For a hands-on tutorial that covers document type creation, see Get Started: Promotion Document Type.

Using the Document Type Editor

The Document Type Editor is designed to be used by developers as part of a development project.

The Document Type Editor is available to users with developer privileges and is located in the Content Workspace in the Document Types section.

Browsing, creating and editing document types is very similar to browsing, creating and editing actual documents.

When editing a document type fields can be added, moved, modified and removed.

To protect the integrity of the live site, document type changes must be associated with a developer project and go through the project review process. A new or modified document type must be merged as part of the project before it is available to authors. However, developers can immediately work with an updated or new document type in the context of the developer project to test changes or to prepare updates to existing content.

Standard Field Types

Bloomreach Experience Manager provides a standard set of field types that can be used to create document types.

Primitive Fields

Primitive fields allow storage and editing of basic data types that have a simple structure.

Boolean

A Boolean field is displayed as a single checkbox. Its value is either true (checked) or false (unchecked). Its default value if false.

Boolean Radio Group

A single value radio button group widget to set a Boolean value. Its default value is false. Optionally, the labels for the true and false options can be read from a value list document.

CalendarDate

A CalendarDate field allows a date to be entered in a text box or through the provided calendar widget.

Date

A Date field includes date as well as time. A date value can be entered in a text box or through the provided calendar widget. A time value can be entered through text boxes for hours and minutes.

Decimal Number

A Decimal Number field is used for decimal values. Its default value is 0.0.

Dynamic Dropdown

A single value dropdown widget populated from a value list.

Html

An Html field is used for formatted text content. It is stored as HTML markup.

Open UI String

An Open UI String field uses the document field extension point to display a custom field type.

Note: The use of OpenUI extensions currently requires additional configuration that can only be performed by Bloomreach. Contact Bloomreach Support if you are interested in using this feature.

Integer Number

An Integer Number field is used for whole numbers. Its default value is 0.

Radio Group

A single value radio button group widget populated from a value list.

Static Dropdown

A single value dropdown widget populated from a static value list specified as comma-separated values in the field properties.

String

A String field is used for single-line plain text content.

Text

A Text field is used for multi-line plain text content.

Compound Fields

Compound Fields are reusable blocks of fields. A Compound Field can contain both Primitive and Compound Fields.

The delivery tier can't sort document query results by fields stored inside a compound type.

Image Link

An Image Link field is used to include an image from the gallery in the document. The delivery tier will resolve the reference and translate it to a website URL on-the-fly. If a brX user tries to delete the referenced image they will see a warning that it is being referred to and deleting the image will cause a broken link in the referring document.

Link

A Link field is used to create an internal link to a different content item (such as a document or asset) in the repository. The delivery tier will resolve the reference and translate it to a website URL on-the-fly. If a brX user tries to delete the referenced content item they will see a warning that it is being referred to and deleting the item will cause a broken link in the referring document.

Resource

A Resource field is used to embed a file (e.g. an image or a PDF document) in a document. The file is stored within the document and can't be reused by other documents.

Rich Text Editor

A Rich Text Editor field is used to store fully featured rich text content. It is stored as HTML markup within the document. The Rich Text Editor provides authors with the freedom to format text and include tables, images, links, etc. The delivery tier will include references to other content items (such as images and links to other documents).

Custom

Custom fields are provided by Bloomreach. They are similar to compound fields in the sense that they are complex fields that cover a more advanced use case. However, they are not created by adding primitive and compound fields together. Instead, they are tailor-made.

Content Block

The Content Block custom field type provides content authors with the ability to add pre-configured compound types to a document, which allows for a more flexible document types in which authors have the freedom to choose which compound(s) to use.
On the content block field configuration, developers can set the following fields:

  • compoundList: a comma-separated list of the available compounds within the content block.
  • contentPickerType: the way the picker buttons will be rendered. The valid values are 'links' (default) and 'dropdown':
    • links: shows as many buttons as available compounds. When hitting a button, adds a new block of that compound type
    • dropdown: presents a dropdown containing all the available compounds and an additional button to add an item of the selected compound of the dropdown.
  • multiple: when the multiple toggle is selected, an author will be able to add as many of the available compounds as they want (including multiple of the same type).
  • maxitems: when the multiple option is selected, the maximum number of items that can be added. If multiple is not selected, the maximum number will be 1, regardless the value of this field.
  • showCompoundNames: the valid values are 'true' (default) and 'false', it determines whether each item should add the compound name on top of it. When it's active, clicking on the name will collapse or expand the item.

Multi Select

The Multi Select field lets authors select multiple elements from a list of possible options. Before setting up this field, the authors have to create a document of the type resource bundle, which will provide the options to be selected.

See Selection Field Configuration in order to get more information on how the resource bundle document can be created.

On the Multi Select Dynamic Dropdown field configuration, developers have the following options:

  • multiselect.type: the possible options are checkboxes and palette. Otherwise, it will default to selectlist. See the images below to get an idea of how these three options get rendered.
  • resourcebundle.id: the ID of the resource bundle document to use for populating the available options.
  • selectlist.maxrows: in case of using the default selectlist representation, this property allows to set the maximum number of elements shown (if there are more elements, a scrollbar will appear).

  • palette.maxrows: in case of using the palette representation, this property allows to set the maximum number of elements shown (if there are more elements, a scrollbar will appear).

  • palette.alloworder: in case of using the palette representation, if set to 'true', it will be possible to manually order the elements on the 'selected' list.

Taxonomy

Taxonomy documents represent a taxonomy hierarchy composed by different levels of categories. In each level of the category tree there might be several 'sibling' categories.

Using a Taxonomy field in a document type, developers can specify a taxonomy, so later, when authors edit a document of that type, they will be able to pick categories from that taxonomy.

In the taxonomy field configuration, developers have the following options:

  • taxonomy.name: the name of the taxonomy document that will be used.
  • multiple: if set to true, this will allow authors to select many categories from that taxonomy, otherwise only one.

Field Properties

Each field in a document type has a number of properties. The exact properties differ per field type, but every field must have at least a Caption property and a Path property.

Caption

The caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.

Path

The path of a field is the name that is used to store the value of the field. Under the hood the product exclusively refers to a field by its path, and the path also determines the property name used in the Delivery API. A path may not contain spaces or special characters.

Hint

Optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.

CSS Classes

Optionally one or more CSS classes can be added in order to apply custom styling to the field.

Required

Any field that is not Optional can be made required by checking the Required checkbox. Authors can't save documents if they haven't entered a value in a required field.

Optional

Any field that is not Required and not Multiple can be made optional by checking the Optional checkbox. Authors can remove the field completely from a document by clicking on an 'X' icon, and add it back by clicking on a '+' icon. This can be particularly useful for compound fields that contain required fields.

An optional field can be removed from a document type's prototype by clicking on the field's 'X' icon in the Document Type Editor.

Multiple and Ordered

Any field that is not Optional can be made multi-valued by checking the Multiple checkbox. This adds plus and minus icons to the field so authors can add or remove values.

A multi-valued field can be made orderable by checking the Ordered checkbox. This adds arrow icons to the field so authors can move values up, down, to the top, and to the bottom. Optionally, the "move to the top" and "move to the bottom" arrows can be hidden by adding the CSS class hide-top-bottom-arrows to the field's CSS Classes property.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?