The Fields Definition tab is where any fields defined in the query are listed. On Dataset Creation, the query will be evaluated to automatically determine its fields. If a field has the same name as a field defined in Master Fields its properties will be inherited from that field (unless Retain Master Field properties was unchecked when the fields were initially fetched into the Dataset definition or the field was subsequently unlinked).
The buttons at the top of the grid have a number of functions:
- Add Calculated Field – opens the Add Calculated Field wizard
- Delete All Fields – deletes all field definitions for this Dataset
- Fetch Fields – Fetches all field definitions for this Dataset
- Validate Fields – Tests the field definitions and reports on any missing fields, data type mismatches or size mismatches
- Master Fields Area – launches the Master Fields module and filters the field list to match those defined in this dataset
The field properties that can be changed on this screen will be shown on the grid.
- Order – The field’s order in the query results.
- Field Name – The name of the field returned by the query.
- Label – The label to apply to this field name when displaying data to users. By default, this will the field name with any underscores replaced with spaces and all first letters of words capitalised. E.g. customer_name becomes “Customer Name”.
- Type – The data type of the field returned by the query (or inherited from Master Fields).
- Size – The character length of a text field.
- New – If true, a field of this name has not been seen before and won’t have an existing Master Field. If false, a Master Field of this name exists and its properties are inherited. (only shows on Dataset Creation)
- Dimension – Used to identify a dimension of data – something that the data can be grouped by when creating visualisations.
- Measure – Used to identify measures of data – something which mathematical calculations can be carried out on (COUNT, SUM, AVERAGE etc.).
- Filter – Used to identify a field that users can filter views on Dashboards by
- Advanced – Clicking this button will open up a dialog containing advanced properties for fields.
- Delete – Clicking this button will delete this field from the result set.
- Master – Fields take their properties from the Master Field by default; if one exists. While linked to the master field only the “Sort Order Field” property can be changed. All other properties are inherited from the master field.
To make changes to a field linked to a Master Field, the field must be unlinked from the master field by clicking on the tick for the chosen field. When unlinked the user will be asked whether they would like to retain the properties from the master field by selecting “YES” or whether they would like to use default values instead by selecting “NO”. After this is done the properties on that field are editable. The field can be linked to the master field but doing so will overwrite the values with those in the master field.