FieldList

Last updated: 9/2/2025

Overview

Lists the fields present in the data model viewer. Is the layout for FieldListDef.

Properties

Name	Description	Type
qItems	Array of items	Array of NxFieldDescription

Name	Description	Type
qIsSemantic	If set to true, it means that the field is a semantic.	Boolean
qIsHidden	If set to true, it means that the field is hidden.	Boolean
q IsSystem	If set to true, it means that the field is a system field.	Boolean
qAndMode	If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.	Boolean
qName	Name of the field	String
qCardinal	Number of distinct field values	Integer
qTags	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII	Array of String
qIsDefinitionOnly	If set to true, it means that the field is a field on the fly.	Boolean
qDerivedFieldData	Lists the derived fields if any.	Null or NxDerivedFieldDescriptionList
qIsDetail	Is used for Direct Discovery. If set to true, it means that the type of the field is detail.	Boolean
qIsImplicit	Is used for Direct Discovery. If set to true, it means that the type of the field is measure.	Boolean

Name	Description	Type
qDerivedFieldLists	Information about the derived fields.	Array of NxDerivedFieldsData.

Name	Description	Type
qDerivedDefinitionName	Name of the derived definition.	String
qFieldDefs	List of the derived fields.	Array of NxDerivedField.
qGroupDefs	List of the derived groups.	Array of NxDerivedGroup.

Name	Description	Type
qId	Identifier of the derived field. The identifier is unique.	String
qName	Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year	String
qMethod	Method name associated to the derived field.	String
qExpr	Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year, the expression is as follows: =${Mydefinition(OrderDate).Year}	String
qTags	List of tags.	Array of String

Name	Description	Type
qId	Identifier of the group.	String
qName	Name of the derived group.	String
qGrouping	Grouping type. The grouping should be either H or C (Grouping is mandatory for derived definitions). Is mandatory.	One of: N for no grouping H for drill-down C for cyclic
qFieldDefs	List of the derived fields in the group.	Array of String

Example

"qFieldList": { "qItems": [ { "qIsHidden": true, "qIsSystem": true, "qName": "$Field", "qCardinal": 30, "qTags": [ "$key", "$hidden", "$system", "$ascii", "$text" ], "qSrcTables": [] }, { "qIsHidden": true, "qIsSystem": true, "qName": "$Table", "qCardinal": 7, "qTags": [ "$key", "$hidden", "$system", "$ascii", "$text" ], "qSrcTables": [] }, { "qIsHidden": true, "qIsSystem": true, "qName": "$Rows", "qCardinal": 7, "qTags": [ "$hidden", "$system", "$numeric", "$integer" ], "qSrcTables": [] }, { "qIsHidden": true, "qIsSystem": true, "qName": "$Fields", "qCardinal": 5, "qTags": [ "$hidden", "$system", "$numeric", "$integer" ], "qSrcTables": [] }, { "qName": "CategoryID", "qCardinal": 5, "qTags": [ "$key", "$numeric", "$integer" ], "qSrcTables": [ "Categories", "Products" ] }, { "qName": "CategoryName", "qCardinal": 5, "qTags": [ "$ascii", "$text" ], "qSrcTables": [ "Categories" ] }, { "qName": "Address", "qCardinal": 1, "qTags": [ "$text" ], "qSrcTables": [ "Customers" ] }, { "qName": "City", "qCardinal": 1, "qTags": [ "$text" ], "qSrcTables": [ "Customers" ] }, { "qName": "ContactName", "qCardinal": 1, "qTags": [ "$text" ], "qSrcTables": [ "Customers" ] } ] }

In this example:

$Field, $Table, $Rows, $Fields are system tables.
CategoryID is a field in the tables Categories and Products.
CategoryName is a field in the table Categories.
Address, City and ContactName are fields in the table Customers.
qCardinal gives the number of distinct field values.

Learn more

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here