id

string

yes

unique identifier.

acl

ref urn:com.cohga.server.acl#1.0:acl

no

Optional ACL to restrict access.

entity

ref urn:com.cohga.server.entity#1.0:entity

yes

The entity that this edit config relates to.

label

string

yes

The label that is displayed to the user for this edit.

datasource

ref urn:com.cohga.server.datasource.jdbc#1.0:datasource

yes

The datasource that contains the table to edit.

table

string

yes

The name of the table within the datasource that is to be edited.

key

string

no

The column in the table that will uniquely identify each row, the primary key will be used if not set.

entityTable

string

no

Specify a different table for the entity id column from the one that's being edited. Requires a join to be configured to link this table to the source table.

entityKey

string

no

Specify a different column for the entity id from the key column specified here. If entityTable is specified the column must be in that table.

join

ref urn:com.cohga.server.editor#1.0:join

no

A join expression for linking the source table and other tables (generally for joins to refine what rows are available, e.g. linking to a status table ).

sort

ref urn:com.cohga.server.editor#1.0:sort

no

Order by clauses to use when retrieving data for display.

parameters

boolean

no

If set to true the table will be examined to determine the information about what columns can be edited and the parameter tags override/supplement this information.

If not set or set to false the parameter tags will determine what columns can be edited.

parameter

ref urn:com.cohga.server.editor#1.0:parameter

no

Describes one column to be edited, can be specified multiple times.

retireColumn

string

no

Column to use to "retire" a record rather than deleting the row when deleting a record. Must be a timestamp column type in the database.

When this column is specified then deleting a record won't delete the record but will instead record the date the record was retired in this column.

Rows with a value in this column won't be included when displaying data from this table to the user.

history

boolean

no

When set to true indicates that a history of the changes made to this table will be recorded in a separate history table. The schema for the history table must match the source table (with the addition of the user and time columns).

historyTable

string

no

The name of the table to record historical data, defaults to the table name plus the suffix "_hst".

historyUserColumn

string

no

The column in the history table to record the user who made the change, defaults to "modified_user"

historyTimeColumn

string

no

The column in the history table to record the time when the change was made, defaults to "modified_time". Must be a timestamp column type in the database.

type

LEFT, INNER, RIGHT

no

Type of join to perform, default is INNER

left

string or object

yes

The left table and column in the join, formatted as TABLE.COLUMN.

<left>TABLE.COLUMN</left> can also be specified using table and column sub-tags, e.g. <left><table>TABLE</table><column>COLUMN</column></left>

right

string or object

yes

The right table and column in the join, formatted as TABLE.COLUMN.

<right>TABLE.COLUMN</right can also be specified using table and column sub-tags, e.g. <right><table>TABLE</table><column>COLUMN</column></right>

string

yes

The column name to sort by. Note this isn't an attribute of the tag, it's the content, e.g. it's <sort>CREATION_DATE</sort>

direction

ASC or DESC

no

Sort direction, <sort direction="DESC">CREATION_DATE</sort>

displayName

string

no

No idea.

helpText

string

no

Description of the input field.

promptText

string

no

The label for the field (can also be called label rather than promptText)

acl

ref urn:com.cohga.server.acl#1.0:acl

no

An ACL to restrict access to the parameter.

hidden

boolean

no

Is the input field displayed?

id

string

yes

A unique id for the parameter

alignment

'left', 'center', 'right' or 'auto'

no

How to align the input.

controlType

'listbox', 'checkbox', 'radiobutton', 'textbox', 'textarea' or 'money'

no

How the input of the field should be presented.

dataType

'any', 'boolean', 'datetime', 'date', 'time', 'decimal', 'float', 'integer', 'string'

no

What is the underlying data type for the column?

allowBlank

boolean

no

Can this field be left blank?

allowNewValues

boolean

no

Is a combo box limited to the defined values or can the user enter their own values?

allowNull

boolean

no

Does the database allow this value to be null?

defaultValue

string

no

The initial value to populate a field with.

displayFormat

string

no

No idea.

fixedOrder

boolean

no

No idea, but apparently you can set it to true or false.

concealValue

boolean

no

Should the input value be hidden when the user types it in (no currently supported in the client).

list

list of values

no

scalarParameterType

'simple' or 'multi-value'

no

If set to multi-value then more than one item can be selected from a list box.

pageSize

integer

no

Number of entries in a list box to display per-page, set to 0 to disable paging.

width

integer

no

Change the width of the input field.

matchType

'start', 'middle', end or 'auto'

no

When searching a list box based on the text the user us typing this determines how the text is used, default is start.

autoSelect

boolean

no

If true then the first value in a list box is preselected.

forceSelection

boolean

no

If true then a value must be chosen from a list box.

typeAhead

boolean

no

If set to true typing in a list box field refines the available values.

minLength

integer

no

The minimum number of characters required for a field.

maxLength

integer

no

The maximum number of characters required for a field.

minValue

no

The minimum value allowed for a field.

maxValue

no

The maximum value allowed for a field.

increment

no

For fields that support it this is the value of the difference between subsequent values, e.g. it's 15 for time fields

uppercase

boolean

no

Should the value be converted to upper-case before being inserted into the database.

sequence

string

no

If the value for the parameter is generated from a database sequence then this is the name.

autogenerated

boolean

no

Is the value for the parameter generated by the database.

trueValue

no

The value stored in the database that indicates that the value us "true".

falseValue

no

The value stored in the database that indicates that the value us "false".

readOnlyOnUpdate

boolean

no

If set to true then the value can not be changed when the record is being updated.

readOnlyOnInsert

boolean

no

If set to true then the value can not be changed when the record is being created.

dataSet

ref urn:com.cohga.server.data.database#1.0

no

Source data definition for list box content

labelColumn

string

no

Parameter in dataSet that contains the label for the list box content

valueColumn

string

no

Parameter in dataSet that contains the value for the list box content

sortColumn

labelColumn or valueColumn or one of 'label', 'value', 'none', 'defined' or 'default'

no

How the content of the listbox should be sorted:

• label - sort based on content of the label

• value - sort based on the content of the value

• none - no sorting

• defined - sorting is provided by the data definition

• default - whatever happens when this value isn't set

Additionally the value could be the same as the labelColumn or valueColumn attribute

value

string

no

The value that should be written to the column, the user will not be able to change this value.

autoExpand

boolean

no

Should a list box be expanded immediately when the user enters the field?

readOnly

boolean