AGGMAPINFO

The AGGMAPINFO function returns information about the specification of an aggmap object in your analytic workspace.

Note:

You can get information about an aggregation specification (that is, an aggmap of type AGGMAP) only after it has been compiled. You can compile an aggregation specification using a COMPILE statement or by including the FUNCDATA keyword when you execute the AGGREGATE command. When an aggregation specification has not been compiled before you use it with the AGGMAPINFO function, then it is compiled by AGGMAPINFO. You do not need to compile an aggmap for use with ALLOCATE.

Table 7-1 Keywords for the choice Parameter of the AGGMAPINFO function

Keyword

Return Value

Description

ADDED_MODELS

TEXT

The models that are currently added to an aggmap using AGGMAP ADD or REMOVE model statements.The names of the models are returned as a multi-line text string.

AGGINDEX

BOOLEAN

Indicates the setting for the AGGINDEX statement in the aggmap. A YES setting specifies that all possible indexes (composite tuples) are created whenever the aggmap is recompiled. (Applies to AGGMAP type aggmaps only.)

CHILDREN member-name

TEXT

The dimension members used in the right-hand side of equations used to calculate temporary calculated members added using MAINTAIN ADD SESSION statements. The names of the members are returned as a multi-line text string.

CUSTOMMEMBERS

TEXT

The members added using MAINTAIN ADD SESSION statements. The names of the members are returned as a multi-line text string.

DIMENSION

TEXT

The names of the dimensions of the models or relations used by the aggmap. The names of the members are returned as a multi-line text string.

Returns AGGMAP for an aggregation specification (that is, when the specification has been entered with the AGGMAP command). You can use this type of aggmap only with the AGGREGATE command or AGGREGATE function.

Returns ALLOCMAP for an allocation specification (that is, when the specification has been entered with the ALLOCMAP command). You can use this type of aggmap only with the ALLOCATE command.

Returns NA when the aggmap has been defined but a specification has not been entered with the AGGMAP or ALLOCMAP command.

MODELS

TEXT

The models in the aggmap. The names of the models are returned as a multi-line text string.

The name of relation that is specified by a RELATION (for aggregation) statement in the aggmap object. Each statement is displayed on a separate line.

STORE

BOOLEAN

Indicates whether the CACHE statement in the aggmap is set to STORE. A YES setting specifies that the data that is calculated on the fly is stored in the cache. (Applies to AGGMAP type aggmaps only.)

VARIABLES

TEXT

The variables for which this aggmap object has been specified as the default aggmap using AGGMAP ADD or REMOVE model statements or the $AGGMAP property. The names of the variables are returned as a multi-line text string.

choice-at-position

Specifies the exactly which piece of information you want returned.

PRECOMPUTE returns the text of the limit-clause that follows the PRECOMPUTE keyword in a RELATION statement. You must use the rel-pos argument to specify a single RELATION statement. Returns NA when the RELATION statement does not have a PRECOMPUTE keyword. (Applies to AGGMAP type aggmaps only.)

RELATION returns the name of the relation that follows the RELATION statement that you specify with the rel-pos argument.

STATUS returns the status list that results from the compilation of the PRECOMPUTE clause in the RELATION statement that you specify with the rel-pos argument. (Applies to AGGMAP type aggmaps only.)

rel-pos

An INTEGER that specifies a RELATION statement in the aggmap. The integer indicates the position of the statement in the list of RELATION statements. You can use the rel-pos argument only with the RELATION, PRECOMPUTE, or STATUS keywords. For example, to get information about the first RELATION statement in an aggmap, use the integer 1 as the rel-pos argument. To get information about the fourth RELATION statement in an aggmap, use the integer 4, and so on. You may use any integer between 1 and the total number of RELATION statements in an aggmap specification. You can use the NUMRELS keyword to obtain the total number of RELATION statements for an aggmap object.

Examples

Example 7-1 Retrieving Information About an Aggmap Object

Suppose an aggmap named sales.agg has been defined with the following statement.

DEFINE sales.agg AGGMAP <time, product, geography>

Suppose the following specification has been added to sales.agg with the AGGMAP command.