XML Definitions for Templates

Element	<template>
Description	Root element
Content	At least one: <tab> <section>
Attributes	None

Element

Description

Root element

Content

At least one:

<tab>

Attributes

None

Element

Description

An optional primary-level layout unit for a template.
If multiple sections are specified, a drop-down is rendered to the left of the tab area to switch between sections.

Content

At least one:

<tab>

Attributes

name
Allowed Values	Text
Default Value	--
Required?	Yes
Description	Name of section to display on page.

Element

<tab>

Description

A primary-level layout unit for a template.
When section elements are used, tabs serve as secondary-level layout units.
If only one tab is present, the tab link is not displayed.

Content

At least one:

<row>

Attributes

name
Allowed Values	Text
Default Value	--
Required?	Yes
Description	Name of tab to display on page.
default-font-size
Allowed Values	small medium large
Default Value	small
Required?	No
Description	Default size for all text inside tab.

Element

<row>

Description

Secondary-level layout unit.
Spans the entire horizontal width of page.

Content

At least one:

<block>

Attributes

show-border
Allowed Values	true false
Default Value	true
Required?	No
Description	If true, border is displayed around row.

Element	<column>
Description	Tertiary-level layout unit. Displays all contained properties in two columns: one for the property label, one for value. Enforce a strict layout for all properties. Enclosing element for simple templates.
Content	At least one: <group> <property> <separator>
Attributes	None

Element

Description

Tertiary-level layout unit.
Displays all contained properties in two columns: one for the property label, one for value.
Enforce a strict layout for all properties.
Enclosing element for simple templates.

Content

At least one:

<group>

Attributes

None

Element

<block>

Description

Tertiary-level layout unit.
Free-form property container.
Provides more flexibility in defining the template's layout.
Allows for more complex user interface.
Suitable for forms-based entry pages.
Does not separate property labels and values.
Enclosing element for form templates.
Uses lines and cells.

A block contains one or morelines, which act as rows within the block. Lines can contain properties, or can optionally contain cells - a 5th level layout unit. Cells can be used to align items across lines. Multiple block elements within a row are rendered side-by-side horizontally.

Content

At least one:

<line>

Attributes

width
Allowed Values	Numeric
Default Value	--
Required?	No
Description	Percentage that determines the width of this block relative to its siblings.

border
Allowed Values	full top bottom left right none
Default Value	none
Required?	No
Description	Value that configures a border to display for the block. none = no border is displayed full = border is displayed on all sides of the block any combination of top, bottom, left, or right = comma-delimited list to draw borders

shaded
Allowed Values	true false HTML-recognized color code
Default Value	false
Required?	No
Description	true = background of line will be shaded using the default color false = background of line will not be shaded value other than true or false = value is treated as HTML-supported color value to shade with (i.e., an RGB color code or a browser-recognized color name)

Element

<line>

Description

4th-level layout unit.
Defines row within block.
Lines can contain items directly, or can contain cells if alignment across lines within a block is desired. See block element.

Content

At least one:

<cell>; or

<text>, <property>, <picklist>, <radio>, <checkbox-view, embedded-list

Attributes

align
Allowed Values	left right center
Default Value	center
Required?	No
Description	Determines position of items within line. If line contains items directly, all items will be rendered together at the left, center, or right side of the line, depending on the alignment value. Value is only obeyed if the line does not contain cells.

border
Allowed Values	full top bottom left right none
Default Value	none
Required?	No
Description	Value that configures a border to display for the block. Value only obeyed if line does not contains cells. If line contains cells, each cell must specify its border if border is desired. none= no border is displayed full= border is displayed on all sides of the line any combination of top, bottom, left, or right = comma-delimited list to draw borders

shaded
Allowed Values	true false HTML-recognized color code
Default Value	false
Required?	No
Description	true = background of cell will be shaded using the default color false = background of cell will not be shaded value other than true or false = value treated as HTML-supported color value to shade with (i.e., an RGB color code or a browser-recognized color name)

Element

<cell>

Description

5th-level layout unit.
Defines a cell within a line.

Content

At least one:

<text>

<horizontal-rule>

<radio>

<checkbox-view

<embedded-list>

Attributes

cell-span
Allowed Values	Numeric
Default Value	1
Required?	No
Description	Number of cells in adjacent lines to span. For example, this value can be used if a cell should span two columns.

line-span
Allowed Values	Numeric
Default Value	1
Required?	No
Description	Number of lines in adjacent columns to span. For example, this value can be used if a cell should span two lines.

border
Allowed Values	full top bottom left right none
Default Value	none
Required?	true = background of cell will be shaded using the default color false = background of cell will not be shaded any combination of top, bottom, left, or right = comma-delimited list to draw borders
Description	Configures a border to display for the cell. none = a border will not be displayed full = a border will be displayed on all sides of the line any combination of top, bottom, left, or right = comma-delimited list to draw borders
shaded
Allowed Values	true false HTML-recognized color code
Default Value	false
Required?	No
Description	true= the background of the cell will be shaded using the default color. false= the background of the cell will not be shaded. value other than true or false = value treated as an HTML-supported color value to shade with (i.e., an RGB color code or a browser-recognized color name). value not provided = the shade of the parent line is inherited.
align
Allowed Values	left center right
Default Value	left
Required?	No
Description	Determines the justification of items within the cell.
vertical-align
Allowed Values	top middle bottom
Default Value	middle
Required?	No
Description	Determines the vertical alignment of items within the cell

Element

<group>

Description

Defines a set of related picklists and properties.

Content

At least one:

Attributes

header
Allowed Values	Text
Default Value	center
Required?	Yes
Description	The header label for the group

value-from
Allowed Values	table field relationship resource literal
Default Value	literal
Required?	No
Description	The source of the header label, which can be the system label for a table, field, relationship, resource key, or literal value

prefix-display
Allowed Values	show hide default
Default Value	default
Required?	No
Description	Indicates whether or not to display relationship prefix labels for the properties in the group

Element

Description

Defines a primitive data field to be displayed in the template.
At least one, but not both of the id and alias attributes must be provided. If both are provided, the alias attribute is ignored.
The following attributes are supported only for properties contained within block containers: checkbox-id, font-size, bold, italic, and underline.

Content

<picklist> - zero or one

Attributes

id
Allowed Values	Text
Default Value	center
Required?	Yes, unless an alias is provided
Description	A field ID for this property. The ID specified must be reachable from the root table of the template. If the field identified is not from the root table, the field ID must be prefixed with a valid relationship prefix.

alias
Allowed Values	Text
Default Value	literal
Required?	Yes, unless an id is provided
Description	A data dictionary field alias. The alias must identify a field in the root table of the template.

size
Allowed Values	Numeric
Default Value	--
Required?	No
Description	The size, in number of characters, of the property input field rendered. If this property is not provided, the minimum value among 75 characters or the field's data dictionary length is used.
rows
Allowed Values	Numeric
Default Value	10
Required?	No
Description	The number of rows to render; this value is only obeyed if the field being rendered is an unlimited text (blob) field
prefix-display
Allowed Values	show hide default
Default Value	default
Required?	No
Description	Indicates whether or not to display the relationship prefix label.
label-display
Allowed Values	left right hide default
Default Value	default
Required?	No
Description	Indicates if and where to display the property label. left= rendered before the value. right= rendered after the value hide= not displayed default= the default behavior for the input control type and enclosing column will be used Note: right is a valid value only if the enclosing container is a block.
label
Allowed Values	Text
Default Value
Required?	No
Description	Can optionally be used to override a field's dictionary label
label-suffix
Allowed Values	Text
Default Value
Required?	No
Description	Appends to the end of the label.
display
Allowed Values	true false
Default Value	true
Required?	No
Description	If false, the property will not be displayed on the detail page. Support for the property will be included in the underlying detail object.
checkbox-id
Allowed Values	Text
Default Value
Required?	No
Description	An identifier that links this property with a checkbox view. If such a link exists, the state of the checkbox view will be driven by the given property.
context
Allowed Values	Text
Default Value
Required?	No
Description	If provided, the property only displayed if the current context matches the specified value. For example, if a student name field should only appear in the context student.std.list.detail, that ID can be specified for this attribute.
font-size
Allowed Values	small medium large
Default Value	small
Required?	No
Description	The font size of the property label.
bold
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the property label will be displayed in bold.
italic
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the property label will be displayed in italics.
underline
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the property label will be underlined.
foreign-id
Allowed Values	Text
Default Value
Required?	No
Description	Property from a foreign table. If a picklist rooted at the same foreign table exists anywhere in the template, this field will be updated.
default-value
Allowed Values	Text
Default Value
Required?	No
Description	A default value to set on the property. This value is resolved at runtime based on the default-value-source attribute.
default-value-source
Allowed Values	parent current session detail preference constant
Default Value
Required?	No
Description	The source of the default value; this attribute must be provided if the default-value attribute is provided.
default-value-mode
Allowed Values	new blank
Default Value	new
Required?	No
Description	new = the default value will only be applied if the template is for a new record. blank = the default value will be applied if the property is blank (even if the record is not new).

Element

Description

Disables an input control based on the value of its parent input element. If the parent input control equals the value in the if-parent-equals attribute, the input control reference in the input-name attribute is disabled. The control is re-enabled if the parent's value is changed.

Content

None

Attributes

input-name
Allowed Values	Text
Default Value
Required?	Yes
Description	The name of a property within the same template.

if-parent-equals
Allowed Values	Text
Default Value
Required?	Yes
Description	The value causing the input control to be disabled.

Element	<picklist>
Description	Defines a complex data field to be displayed in the template. Picklists allow the user to choose a related object. Objects are chosen via a popup window that displays the selectable items
Content	<<a class="glossterm" href="javascript:TextPopup(this)" id="HotSpot28060">filter> - zero or more <field> - at least one
Attributes	None

Element

Description

Defines a complex data field to be displayed in the template. Picklists allow the user to choose a related object. Objects are chosen via a popup window that displays the selectable items

Content

<<a class="glossterm" href="javascript:TextPopup(this)" id="HotSpot28060">filter> - zero or more

<field> - at least one

Attributes

None

Element

Description

Represents a filtering criteria for a list. Filter elements can be nested.

Content

<filter> - zero or more

Attributes

field
Allowed Values	Text
Default Value
Required?	Yes
Description	An id representing the field by which the list is filtered.

operator
Allowed Values	equals empty greaterThan greaterOrEqual lessThan lessOrEqual notEmpty notEqual beginsWith contains endsWith
Default Value
Required?	Yes
Description	Operator that compares the filter field to the value.
source
Allowed Values	parent current session detail preference constant input
Default Value
Required?	Yes
Description	The entity that contains the value for the filter. For the empty and notEmpty operators this value must beconstant.
value
Allowed Values	Text
Default Value
Required?	Yes, unless the operator is empty or notEmpty
Description	The value for the filter. This attribute has different interpretations depending upon the source attribute, and is not required for the empty and notEmpty operators.
connector
Allowed Values	and or
Default Value	and
Required?	Yes
Description	The logical connector used to combine this filter with the previous filter in the node.

Element

<field>

Description

Represents a field in a picklist.

Content

None

Attributes

id
Allowed Values	Text
Default Value	--
Required?	Yes
Description	Represents the field to display in the picklist.

sort
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the picklist will be sorted by this field. Within a picklist, multiple fields can be designated as sort fields.

Element

<radio>

Description

An alternate UI component for collecting an input for a property. At least one, but not both of theidandaliasattributes must be provided. A set of radio buttons are grouped by their id/alias values.

A radio button's label text is specified by its body text. If a radio button's property is backed by a reference table, and the value attribute contains a valid reference code from that table, the description of that code will automatically be used as the radio button's label if body text is omitted.

Content

Text

Attributes

id
Allowed Values	Text
Default Value	--
Required?	Yes, unless an alias is provided.
Description	A field ID for this property. The ID specified must be reachable from the root table of the template. If the field identified is not from the root table, the field ID must be prefixed with a valid relationship prefix.

alias
Allowed Values	true false
Default Value	false
Required?	Yes, unless an id is provided.
Description	A Data Dictionary field alias. The alias must identify a field in the root table of the template.

value
Allowed Values	Text
Default Value	--
Required?	Yes
Description	The value associated with this radio button. If this radio button is selected, the value in this attribute will be set on the corresponding field.
other
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, this radio button will be treated as an other option and a text input field will be rendered next to the radio button, allowing the user to enter an arbitrary value. Note that other type radio buttons will cause validation errors for fields requiring valid reference codes only.
font-size
Allowed Values	small medium large
Default Value	small
Required?	No
Description	The font size of the radio label.
bold
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the property radio will be displayed in bold.
italic
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the property radio will be displayed in italics.
underline
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the property radio will be underlined.

Element

<text>

Description

Supports the display of static text. The text to display is specified within the body of the element.

Content

Text

Attributes

font-size
Allowed Values	small medium large
Default Value	small
Required?	No
Description	The font size of the text.

bold
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the text will be displayed in bold.

italic
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the text will be displayed in italics.
underline
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the text will be underlined
source
Allowed Values	field table relationship modelProperty literal resource
Default Value	literal
Required?	No
Description	Determines how to interpret the body content field = the body content is a field ID table = the body content is a table ID relationship = the body content is a relationship ID modelProperty = the body content is a property literal = the body content is the actual string to display resource = the body content is a resource string

Element

<horizontal-rule>

Description

Displays a horizontal line. The width of the line is determined by width of the containing cell.

Note: A horizontal rule cannot be rendered directly within a line

Content

None

Attributes

weight
Allowed Values	Numeric
Default Value	1
Required?	No
Description	The height (thickness), in pixels, of the horizontal line.

Element

Description

Renders an area of whitespace of specified dimensions.

Content

None

Attributes

width
Allowed Values	Numeric
Default Value	1
Required?	No
Description	The width, in pixels, of the whitespace area
height
Allowed Values
Default Value
Required?
Description	The height, in pixels, of the whitespace area

Element

<break>

Description

Renders a line break.

Content

None

Attributes

None

Element

<checkbox-view

Description

Renders a read-only checkbox whose state is determined by the value of a linked property. A checkbox view is not associated with an underlying property and does not control the value of any field.

Content

None

Attributes

checkbox-id
Allowed Values	Numeric
Default Value	1
Required?	Yes
Description	The ID of the checkbox view. A checkbox view and a property are linked by a common checkbox ID

when
Allowed Values	empty notEmpty
Default Value	notEmpty
Required?	No
Description	Determines when the checkbox view should be set to a checked state. empty = the checkbox view will be checked if the linked property does not contain a value notEmpty = the checkbox view will be checked if the linked property contains a value

label
Allowed Values	Text
Default Value	--
Required?	No
Description	The label to display next to the checkbox view.
font-size
Allowed Values	small medium large
Default Value	small
Required?	No
Description	The font size of the label.
bold
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the label will be displayed in bold.
italic
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the label will be displayed in italics
underline
Allowed Values	true false
Default Value	false
Required?	No
Description	If true, the label will be underlined.

Element

Description

Defines an exact size for a gutter between template elements.

Content

None

Attributes

height
Allowed Values	Numeric
Default Value	1
Required?	Yes
Description	The height, in pixels, of the gutter.
width
Allowed Values	Numeric
Default Value	1
Required?	Yes
Description	The width, in pixels, of the gutter.

Element

<embedded-list>

Description

Displays a list of child records directly within the page. Records can be added to, deleted from, or modified within the list if the user has the necessary privileges. The fields to display and the sort order of the list are specified by child field elements.

Filters can also be specified. System value elements can be specified if values should be automatically set on the list's records on save.

Content

<filter> - zero or more

<field> - at least one

<system-value> - zero or more

Attributes

id
Allowed Values	Text
Default Value	1
Required?	Yes
Description	A value that uniquely identifies an embedded list within a template.

relationship
Allowed Values	Text
Default Value	1
Required?	Yes
Description	The relationship from the template's primary data class to the data class of the embedded list's records

detail-context
Allowed Values	Text
Default Value
Required?	No
Description	A context to identify the template to use for adding and modifying the embedded list's records.
popup-width
Allowed Values	Numeric
Default Value	200
Required?	No
Description	The width, in pixels, of the popup window used for adding and modifying the embedded list's records.
popup-height
Allowed Values	Numeric
Default Value	300
Required?	No
Description	The height, in pixels, of the popup window used for adding and modifying the embedded list's records.

Element

<system-value>

Description

Represents a value to be set automatically on a bean for a detail node. This element is typically used to set system required values on records, such as context-specific OIDs.

Note that a system-value is not required to set district OID values; these values are set automatically based on the session district OID on all applicable beans.

Content

None

Attributes

field
Allowed Values	Text
Default Value	1
Required?	Yes
Description	ID of the field to set.

source
Allowed Values	parent current session detail preference constant input
Default Value	--
Required?	Yes
Description	The entity that contains the value to set.

Value
Allowed Values	Text
Default Value	--
Required?	Yes
Description	The value to set; this attribute has different interpretations depending upon the source attribute.