...
| Name | Type | Required | Description |
|---|---|---|---|
| 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 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:
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 | no | If set to true then the value can not be changed. |
...