Represents a query.
Defines references to query subject or table that can be in the same or different module. used to resolve one part name in query item.
The original ref used before resolving the query subject. It's used in the metadata and allows for restoring the ref when saving a module from metadata.
Defines whether the object is a copy or a reference.
Causes a query to generate the SQL commands used. If set to minimized, only the required query items appear in the generated SQL. If set to asView, all query items appear.
Related with the contextSensitiveJoinSelection governor, when the setting is explicit
If set to true, the querySubject will be used in the joinPath
number of rows of the query subject in text format, e.g. 1K, 2M.
Defines the intended usage of the query subject.
Property that is processed in relational query planning when the query subject usage is specified as summaryQuery.
A query item from a query subject. Obsolete location (after 3.2). The new location is querySubject/item[n]/queryItem
Defines a query against the specified database.
reference to database.
A query that represents the union, intersection or except of query subjects or tables. union can have more than two query subjects or tables.
reference to other query subjects or tables.
A query that represents the join of two query subjects or tables.
The available sort list when projecting the entire query subject.
This is the location of selectable items for query formulation as of version 3.4. This also support folders of selectable items.
if sortList is absent, sort on the query item/calculation ASC NULLS LAST.
The facet value will be combined with the context values.
Example: Week without context gives 53 values. Week with Year as context gives 53 values for each year that is in the data.
For cases where the context is not sufficiently spelled out, the reference can be to an expression that combines a number of columns. Example: day of week name gives 7 values without context, with Week as context there would be 366 values. Day of Week combined with an expression 100*year + week number will give 366 values per year.
reference to context query item/calculation.
define the behavior if context is missing in the query.
A query item from a query subject
Concepts from SMD.
minimum value retrieved during SMD. The text format is: sign + decimal + abbreviation for thousand, million, billion.
Example: -100, -1.3K, -2.1M, -0.4G
maximum value retrieved during SMD. The text format is: sign + decimal + abbreviation for thousand, million, billion.
Example: 50, 3K, 5M
number of distinct values retrieved during SMD. The text is at most 3 digits: decimal + abbreviation for thousand, million, billion.
Example: 5, 4.5K, 1G
number of null values retrieved during SMD. The text is at most 3 digits: decimal + abbreviation for thousand, million, billion.
Example: 5, 4.5K, 1G
Whether values are naturally ordered (year, month number, ect) or not (identifier). When true their value adds meaning for prediction.
When sourceCategory=hierarchy/* then this property defines if the hiearchy has a single root or if it has multiple roots.
Some hierarchies have the artificial all-member and thus get 'forced' into a single root hierarchy, but that is often not interesting for the user, who is likely more interested in the members one level down from a single root hierarchy. For a multi-root hierarchy it would likely be more interesting to show all the roots to start with.
The label is used as the caption.
In relational terms it defines a new row, base on other rows. In Olap terms it defines a new member, based on other members. E.g. kitchen_furniture = [table] + [chair], YOY_difference = [2016] - [2015].
Only supported when
1) sourceCategory=hierarchy/*
2) the hierarchy has a single root
3) the underlying source returns it as part of the metadata
Cognos SQL can be optimized by the system and combined with other SQL before being sent to the data source.
Native SQL cannot be modified except by macro substitution, but can be combined with other SQL into a single SQL query to send to the data source.
Pass-through SQL cannot be modified except by macro substitution, and cannot be combined with other SQL. It must be sent to the data source as a stand-alone query. However, results can be combined with results of other queries.
No predicate is generated.
Generates an IN predicate of constant values.
Generates a BETWEEN predicate comprised of MIN and MAX values of the join keys.
Generates a table row constructor form of the IN predicate.
issue a warning.
context is required in query (project or in filter).
provide detail information if context is missing in the query.
automatic is resolved to true or false. Rule: true if the usage of the query item/calculation is attribute, and the data type supports precise value comparison (e.g. false for float/double because they are approximate number)
Specifies that the querySubject usage is automatic and therefore it will be computed by the planning code.
Specifies that the querySubject refers to a bridge table.
Specifies that the querySubject will be treated as a summaryQuery.
Specifies that all query items appear in the generated SQL.
Specifies that only the required query items appear in the generated SQL.
Specifies that the usage is not known.
Specifies that the object is to be treated as an identifier.
Specifies that the object is to be treated as a fact.
Specifies that the object is to be treated as an attribute.
The aggregation rule. same as V5 aggregate name.
This item should be used as a grouping item.
Compute the average value for the values of the group.
The aggregation rule is determined automatically at run time.
Aggregation is performed on the elements before the rest of the expression is executed. For example, if the aggregate rule for Q1_a is set to total, and the rule for q1_b is set to average, then if this query item is based on the expression (QI_a / QI_b) * 100, the aggregate is computed as: ( total(QI_a) / average( QI_b ) ) * 100.
Compute the number of the values of the group.
Compute the number of distinct values in the group.
Compute the number of the values of the group, excluding zero and NULL values.
Compute the maximum value of the values of the group.
Compute the median value of the values of the group.
Compute the minimum value of the values of the group.
Compute the standard deviation value of the values of the group.
Compute the sum of the values of the group.
Compute the variance value of the values of the group.
The related item must not be used as a grouping item and must not be aggregated. This value is used for the item that represents the property of a level of a dimension.
Specifies that this object has no rows.
Specifies that this object has one row only.
Specifies that this object can have many rows.
References a query subject or table.
The minimum number (cardinality) of rows that will match this end of the relationship. Normally zero or one.
The maximum number (cardinality) of rows that will match this end of the relationship. The value is normally one or many.
A collection of ordered facet/member values that can be projected or that can be used as a filter.
Example: set ( year->[2015], year->[2016] )
usage=attribute
format = "null"
datatype = nvarchar(200)
highlevelDatatype = string
number of distinct values. The text format is: at most 3 digits + abbreviation for thousand, million, billion. Example: 5, 4.5K, 1G
The reference(idForExpression) to the hierarchy that the members of the this set belong to.
join two query subjects / tables.
Defines a reference to a relationship in a referenced module.
Defines whether the object is a copy or a reference.
References the left query subject or table in a relationship.
References the right query subject or table in a relationship.
Presence of this element triggers filter join optimization in which is generated in order to optimize local join processing. The filter will be applied to the many side of the relationship. If there is no many side or if both are many, then the filter will be applied to the right side.
A lookup table for controlling query generation. As a minimum, the _env and _governor maps are required.
Specifies the value to use if no key match is found. If not set, external sources for parameterMaps of this name may be searched.
During macro evaluation, the parameter map will be reloaded if it was loaded more than the specified number of seconds ago. The default is -1, which means that the data will be loaded only once.
When set to true, then the map will be loaded one key-value at a time, when a key-ed accesses is made. When a getAllEntries access is made, then this flag is ignored.
Specifies that the object is an entry in a parameter map.
Defines the unique identifier for the object.
The value that gets returned when the parameter map locates the key value.
Specifies that the set of entries in the parameterMap is based on two queryItem references: one represents the set of keys, and the second represents the set of values.
The queryItems being referenced must belong to the same querySubject.
When a parameterMap has been defined, the query looks for this unique identifier when it executes and returns the value in the valueRef element.
When a parameterMap has been defined, and the unique identifier (keyRef) has been found by the query, this value gets returned when the query executes.
Defines an expression aggregate that returns a value.
Specifies an expression used to query the data in the specified database.
Represents a set of items related to each other as “coarse to fine". It is used as a Navigation Path. The items are allowed to come from multiple query subjects.
represents an item in drillGroup.
reference to a query item in the same module.
Represents a set of items related to each other as “coarse to fine". The items must be from the current query subject.
OBSOLETE, planned removal 2017-06-01,
Replaced by localRef. reference to a query item in the same query subject.
The label is used as the caption.
In relational terms it defines a new row, based on other rows. In Olap terms it defines a new member, based on other members. E.g. kitchen_furniture = [table] + [chair], YOY_difference = [2016] - [2015].
local references to query items within the same query subject
Reference to table that defines the columns to be split into
A selectable item can be a child of another selectable item. This occurs for OLAP based levels and the properties that belong to that level. It also happens for structures, where the structure name itself may be selectable, giving a summarized/calculated response of the structure.
A rule that decide if a column can be split.
Column Split configuration, saved in the ModelingService configuration file.
Specifies the item data classification and whether it represents a geographic or time related concept.
cPosition is the lat/long combination
A projectable item referring to an underlying source item (column, level, attribute, named set) or a calculation based on such items.
Selectable/dragable filters.
The folder itself can not be used in a query, but its non-folder contents can.
Specifies the level of flexibility the system is allowed in optimizing the SQL from this element, before presenting it to the data source.
A hint to allows the UI to provide a recognizable icon based on the underlying source.
A hint for the Predict code.
selectable item
reference to query item/calculation.
Used when this generic query item is based on the definition of another query item, which may reside in the current data module or an imported data module.
Defines whether this object is a copy or a reference.
Defines the intended usage of the query item.
Specifies the format.
This operation (e.g. total, minimum) is applied to detail data values to compute a summarized value. One summarized value is computed for each of the combination of grouping items in the query.
This operation is not applied to pre-summarized data sources, e.g. OLAP sources.
High level datatype. This is obsolete as of 3.0, use highlevelDatatype instead.
High level datatype.
If facetDefinition is absent, treat it as automatic (see enabled in facetType).
A selectable item can be a child of another selectable item. This occurs for OLAP based levels and the properties that belong to that level. It also happens for structures, where the structure name itself may be selectable, giving a summarized/calculated response of the structure.
This element value is not persisted, but dynamically generated.
static: do not use another regularAggregate value than specified
dynamic: use any of the standard aggregations in place of the regularAggregate
The value dynamic is returned for all relational columns and DMR measures, for anything else static is returned.
Role hint for Predict code.
The label is used as the caption.
In relational terms it defines a new row, based on other rows. In Olap terms it defines a new member, based on other members. E.g. kitchen_furniture = [table] + [chair], YOY_difference = [2016] - [2015].
must only reference facet values of the current queryItem or members of the current itemHierarchy
Local reference must only reference to the query items within the same query subject
reference to a query item in the same query subject.