KB Version:

Page Navigation

    Learning Levels

    Most Read

    Data Definition Schema Reference

    group

    Tag NameParent ElementDescriptionReq.
    group{group}

    Used to group collections of fields together with a border around the contained items. Groups can be nested inside of other groups.

    No

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    identifier[alphanumeric]

    The name of the resultant XML tag upon outputting the Data Definition

    Yes
    label[string]

    The text displayed on the screen as the title of the grouping

    No
    multipletrue, false

    Whether or not this group of items can be repeated by the user

    No
    maximum-number[numeric]

    The maximum number of times this group can be repeated (only applicable if multiple="true").

    No
    minimum-number[numeric]

    The minimum number of times this group should be repeated (only applicable if multiple="true").

    No
    restrict-to-groups[groups]

    A comma separated list of groups that his field is restricted to for access purposes. If the user is not a member of one of the groups, the field does not appear.

    No
    collapsedtrue, false

    States whether or not the group should be collapsed upon the form load. The user can always manually collapse and expand groups after the form loads. Default: false.

    No


    asset

    Tag NameParent ElementDescriptionReq.
    asset{group}

    Used to allow the user to choose an existing asset within the CMS. (limited to pages, files, blocks, and symlinks)

    No

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    identifier[alphanumeric]

    The name of the resultant XML tag upon outputting the Data Definition.

    Yes
    label[string]

    The text displayed on the screen as the label of the asset chooser.

    No
    multipletrue, false

    Whether or not the user is allowed to create additional assets.

    No
    requiredtrue, false

    Whether or not this field is required.

    No
    help-text[string]

    Help information that is specific to the field. This help text pop-up when the user moves their mouse over the label.

    No
    maximum-number[numeric]

    The maximum number of additional fields allowed (only applicable if multiple="true").

    No
    minimum-number[numeric]

    The minimum number of times this asset should be repeated (only applicable if multiple="true").

    No
    type"page", "file", "block", "symlink", or "page,file,symlink"

    The type of asset chooser used to filter the available choices. A value of "page,file,symlink" will allow any of those three asset types to be selected in a single chooser.

    Yes
    render-content-depth1-231, unlimited

    This specifies how many levels deep content of nested asset choosers should be rendered, including the current asset. For example, "1" means only content of current asset should be rendered and content of selected asset should not be rendered; "2" means that content of current and selected asset should be rendered, but if selected asset contains any asset choosers, then contents of selected assets for those choosers should not be rendered. If this attribute is not specified, or an invalid value is present, a value of "1" is assumed.

    No
    restrict-to-groups[groups]

    A comma separated list of groups that his field is restricted to for access purposes. If the user is not a member of one of the groups, the field does not appear.

    No


    text

    Tag NameParent ElementDescriptionReq.
    text{group}

    Used for manual input from the user resulting in a text valued stored for the XML.

    No

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    identifier[alphanumeric]

    The name of the resultant XML tag upon outputting the Data Definition.

    Yes
    label[string]

    The text displayed on the screen as the label of the text field.

    No
    multipletrue, false

    Whether or not the user is allowed to create additional text fields.

    No
    requiredtrue, false

    Whether or not this field is required.

    No
    default[string]

    The default value of the text field.

    No
    multi-linetrue, false

    For text input fields, whether or not it should have multiple input lines.

    No
    maximum-number[numeric]

    The maximum number of additional fields allowed (only applicable if multiple="true").

    No
    minimum-number[numeric]

    The minimum number of additional fields (only applicable if multiple="true").

    No
    regular-expression[JavaScript regular expression]

    A JavaScript regular expression with which to match the data inputted by the user. If the regular expression provided is invalid, it will be ignored. Non-required fields that are left empty will not be validated against the regular expression.

    No
    input-data-format[string]

    The value to display to the user if the regular expression doesn't match.

    No
    wysiwygtrue, false

    Whether or not the text field should be a visual word processor.

    No
    wysiwyg-toolbar-removefont formatting, font assignment, text formatting, insert image, insert table, html view

    Elements of the wysiwyg that can be removed from the toolbar. (Is only valid when wysiwyg value is true.)

    No
    rows[numeric]

    Number of rows when multi-line=”true”.

    No
    cols[numeric]

    Number of columns when multi-line=”true”.

    No
    maxlength[numeric]

    The maximum number of characters in a standard text field.

    No
    size[numeric]

    The width of a standard text field.

    No
    help-text[string]

    Help information that is specific to the field.

    No
    typecheckbox, dropdown, radiobutton, multi-selector, datetime

    The type of text input field. Leave attribute out for a standard text input box. Please note that the value "calendar" is deprecated in favor of "datetime."

    No
    restrict-to-groups[groups]

    A comma separated list of groups that his field is restricted to for access purposes. If the user is not a member of one of the groups, the field does not appear.

    No
    allow-custom-valuestrue, false

    For dropdown fields only; specifies whether or not a user can enter a custom value into the field.

    No


    checkbox-item

    Tag NameParent ElementDescriptionReq.
    checkbox-itemtext

    Available items only used with text type of checkbox.

    Yes

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    value[string]

    The value to be shown on the screen and displayed in the resulting XML.

    Yes
    checkedtrue, false

    Whether or not this item is currently checked.

    No
    show-fields[string]

    Contains paths to fields that should appear when this checkbox is checked. These fields will be hidden by default. Field paths should be comma separated. The field path should include the field's ancestor group identifiers and the field's identifier. Each section of the path should be separated by "/" character, for example: "fieldIdentifier, groupIdentifier/fieldIdentifier, group1Id/group2Id/fieldId".

    No


    dropdown-item

    Tag NameParent ElementDescriptionReq.
    dropdown-itemtext

    Available items only used with text type of drop down.

    Yes

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    value[string]

    The value to be shown on the screen and displayed in the resulting XML.

    Yes
    show-fields[string]

    Contains paths to fields that should appear when this dropdown item is selected. These fields will be hidden by default. Field paths should be comma separated. The field path should include the field's ancestor group identifiers and the field's identifier. Each section of the path should be separated by "/" character, for example: "fieldIdentifier, groupIdentifier/fieldIdentifier, group1Id/group2Id/fieldId".

    No


    selector-item

    Tag NameParent ElementDescriptionReq.
    selector-itemtext

    Available items only used with text type of multi-selector.

    Yes

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    value[string]

    The value to be shown on the screen and displayed in the resulting XML.

    Yes
    selectedtrue, false

    Whether or not this item is currently selected.

    No
    show-fields[string]

    Contains paths to fields that should appear when this item is selected. These fields will be hidden by default. Field paths should be comma separated. The field path should include the field's ancestor group identifiers and the field's identifier. Each section of the path should be separated by "/" character, for example: "fieldIdentifier, groupIdentifier/fieldIdentifier, group1Id/group2Id/fieldId".

    No


    radio-item

    Tag NameParent ElementDescriptionReq.
    radio-itemtext

    Available items only used with text type of radio button.

    Yes

    Attribute(s)

    Attribute NameValuesDescriptionReq.
    value[string]

    The value to be shown on the screen and displayed in the resulting XML.

    Yes
    show-fields[string]

    Contains paths to fields that should appear when this radiobutton is selected. These fields will be hidden by default. Field paths should be comma separated. The field path should include the field's ancestor group identifiers and the field's identifier. Each section of the path should be separated by "/" character, for example: "fieldIdentifier, groupIdentifier/fieldIdentifier, group1Id/group2Id/fieldId".

    No