This appendix provides a structural definition of the documentation file LOVDefinitions.xml. This file defines all predefined lookup grid and Dataspy definitions for field validations. Some of these elements are strictly documentation as they are returned as part of the normal grid header response. Others are input data needed to run the LOV query, such as parameters data. The corresponding grid request and response elements and attributes are shown in () in the description.
|
Element |
Attrib |
Description |
Occurs |
Lvl |
|---|---|---|---|---|
|
i) GRIDS |
Outer element for all LOV grids |
1 |
1 |
|
|
LOV |
Definition for one List Of Value query |
1 to n |
2 |
|
|
ID |
Grid ID (GR ID_ ID) |
1 |
||
|
Description |
Grid description (GRIDLABEL) |
1 |
||
|
LVNAME |
Grid Name for lookup (GRID_NAME) |
1 |
2 |
|
|
PARAMETERS |
List of optional parameters |
0 to n |
2 |
|
|
PARAMETER |
Definition for the parameter to substitute in LOV_PARAMETER |
1 |
3 |
|
Element |
Attrib |
Description |
Occurs |
Lvl |
|||
|---|---|---|---|---|---|---|---|
|
FIELDLIST |
List of all available fields for filter/display/sort. Corresponds to the FIELDS definition in GWS result. |
1 |
2 |
||||
|
FIELD |
Definition for a field |
0 to n |
3 |
||||
|
ID |
Field ID (FIELDS Aliasnum) |
1 |
4 |
||||
|
Filterable |
"Y" if filterable field (FIELDS Filterable) |
0,1 |
|||||
|
Displayable |
"Y" if displayable field (FIELDS Visible) |
0,1 |
|||||
|
NAME |
Field label (FIELDS Label) |
1 |
4 |
||||
|
TAGNAME |
Field name or tagname (FIELDS Name) |
1 |
4 |
||||
|
DATASPYLIST |
List of defined Dataspies |
1 |
2 |
||||
|
DATASPY |
Each Dataspy |
1 to n |
3 |
||||
|
ID |
Dataspy ID |
1 |
|||||
|
Name |
Name of Dataspy |
1 |
|||||
|
RETURNCOLUMNS |
List of columns returned by this Dataspy. Corresponds to the FIELDS definition in GWS result. |
1 |
4 |
||||
|
COLUMN |
Definition for each field/column |
1 to n |
5 |
||||
|
COLUMNNAME |
Label for column (FIELDS Label) |
1 |
6 |
||||
|
TYPE |
Data Type (FIELDS Type) |
1 |
6 |
||||
|
TAGNAME |
Field name or tagname (FIELDS Name) |
1 |
6 |
||||