Analysis Studio Query Specification

IBM® Cognos® Analysis Studio defines each group of rows and columns as a set. When you import an analysis into IBM Cognos Report Studio, the report will have one query that processes all the sets found on the crosstab. Each set is defined by data items that segment and summarize the base set definition. To maintain reports converted from Cognos Analysis Studio, you must understand what each of these items represents and how they relate to each other.

Before you modify any of the data items in the Cognos Analysis Studio set definitions, we recommend that you fully understand each data item and its dependencies. Modifying the data items may cause unpredictable results and may slow the performance of your report.

The data items for a set specify the following:

the set definition
set segments, including which members were excluded and hidden individually
filter rules for defining which members are to be retrieved
calculations for Subtotal (N items), More & Hidden, Subtotal (included), Subtotal (excluded), and the total
For more information, see the IBM Cognos Analysis Studio User Guide.
which subtotals should appear
any user-defined calculations

Figure 1. Components of a Cognos Analysis Studio crosstab

The default measure identifies which measure is the default for the crosstab or chart. If no default measure is specified, the default measure may be empty.

Set Definitions

The following table shows the definitions and dependencies for the data items in the set definition.

Data item	Definition	Dependencies
<set name> (base)	Defines the set of members to be used for sorting, filtering, and summary operations. This data item provides a generic reference for all other data items and may reference one of the other set definitions.	None
<set name> (level)	Identifies the level for a level-based set.	None
<set name> (list)	Defines the list of members in a selection-based set.	None
<set name> (depth N)	Defines the set of members at N, number of levels down.	None
<set name> (named set)	References a predefined set.	None

Set Segments Definitions

The following table shows the definitions and dependencies for the data items in the set segment definition.

Data item	Definition	Dependencies
<set definition> (hidden list)	Lists the members that are manually hidden using the Hide command in Cognos Analysis Studio. This set appears when you try to unhide a member.	<set definition>
<set definition> (included set)	Lists the set of members after filters are applied and hidden items are excluded, but before the More limit is applied. Sort or order operations, if any, are defined in this data item.	<set definition> (hidden list)
<set definition> (visible items set)	Limits the set to show the number of members according to the More limit with a small tolerance. The tolerance allows showing the last two members if they are all that remain in the More portion of the set. The choice of visible members can be based on a sort order.	<set definition> (included set)
<set definition> (excluded list)	Identifies members that were manually excluded from the analysis. If no members were manually excluded, the expression defines an `emptySet`. This set appears when you try to remove a member from the Excluded items list in the Properties pane.	<set definition>

Filters

The following table shows the definitions and dependencies for the data items in the filter.

Data item	Definition	Dependencies
<set definition> (filter rules)	Specifies the user-defined filter rules to reduce the set definition using operators such as greater than or less than based on measures, calculations, or attributes.	<set definition>
<set definition> (excluded filters)	Removes members that were manually excluded from the results after applying the user-defined rules.	<set definition> (excluded list), <set definition> (filter rules)
<set definition> (filter top bottom)	Focuses on the members based on top / bottom / first n where n can be a count or a percentile. For more information about Top/Bottom filters, see the IBM Cognos Analysis Studio User Guide.	<set definition> (excluded filters) and totals for sets on the opposite axis
<set definition> (filter rules)	Specifies the user-defined filter rules to reduce the set definition using operators such as greater than or less than based on measures, calculations, or attributes.	<set definition>

Subtotals and Related Conditions

The following table shows the definitions and dependencies for the data items in the subtotals and related conditions.

Data item	Definition	Dependencies
<set definition> (subtotal)	Aggregates the visible items in the set.	<set definition> (visible items set)
<set definition> (subtotal display)	Shows the subtotal if the number of included items is greater than the number of visible items.	<set definition> (visible items set), <set definition> (included set), <set definition> (subtotal)
<set definition> (more and hidden subtotal)	Calculates the More & hidden subtotal by subtracting the aggregation of the included members from the aggregation of those members that were manually hidden or hidden by exceeding the maximum display limit. Not available for selection-based sets.	<set definition> (included set), <set definition> (visible items set), <set definition>
<set definition> (more and hidden subtotal as set)	Converts the More & hidden subtotal member to a set for use in set operations.	<set definition> (more and hidden subtotal)
<set definition> (more and hidden subtotal as member)	Generically references the More & hidden subtotal.	<set definition> (more and hidden subtotal)
<set definition> (more and hidden subtotal display)	Shows the More & hidden subtotal if the number of items hidden or clipped is greater than zero.	<set definition> (more and hidden subtotal)
<set definition> (included subtotal)	Calculates the Subtotal (included). For selection-based sets, this data item references the summary data item for the set.	<set definition> (included set)
<set definition> (included subtotal display)	Shows the Subtotal (included) if any members passed the filter criteria.	<set definition> (included set)
<set definition> (excluded subtotal)	Calculates the value for Subtotal (excluded). This data item is not available for selection-based sets.	<set definition> (total), <set definition> (included subtotal), <set definition>
<set definition> (excluded subtotal display)	Shows Subtotal (excluded) if the number of members in the filtered set is less than the base set. This means that the filter rule is filtering out something.	<set definition> (excluded subtotal), <set definition>
<set definition> (total)	Identifies the total for the set. This value is calculated directly from the data store. The expression used to calculate the summary depends on the set type: Details-based set: The selected member. Level-based and depth-based sets: The root member for the hierarchy. Selection-based set: The aggregate, typically the sum, of the selected members.	<set definition>