MDSCHEMA_ACTIONS Rowset

Describes the actions that may be available to the client application.

Rowset Columns

The MDSCHEMA_ACTIONS rowset contains the following columns.

Column name Type indicator Length Description
CATALOG_NAME DBTYPE_WSTR The name of the database.
SCHEMA_NAME DBTYPE_WSTR Not supported. Always contains VT_NULL.
CUBE_NAME DBTYPE_WSTR The name of the cube to which this action belongs.
ACTION_NAME DBTYPE_WSTR The name of this action.
ACTION_TYPE DBTYPE_I4 A bitmap that is used to specify the action's triggering method. The Msmd.h file defines the following bit value constants for this bitmap:

MDACTION_TYPE_URL (0x01)

MDACTION_TYPE_HTML (0x02)

MDACTION_TYPE_STATEMENT (0x04)

MDACTION_TYPE_DATASET (0x08)

MDACTION_TYPE_ROWSET (0x10)

MDACTION_TYPE_COMMANDLINE (0x20)

MDACTION_TYPE_PROPRIETARY (0x40)

MDACTION_TYPE_REPORT (0x80)

MDACTION_TYPE_DRILLTHROUGH (0x100)
COORDINATE DBTYPE_WSTR A Multidimensional Expressions (MDX) expression that specifies an object or a coordinate in the multidimensional space in which the action is performed. It is the responsibility of the client application to provide the value of this restriction column.

The CORDINATE must resolve to the object specified in COORDINATE_TYPE.
COORDINATE_TYPE DBTYPE_I4 A bitmap that specifies how the COORDINATE restriction column is interpreted. The Msmd.h file defines the following bit value constants for this bitmap:

MDACTION_COORDINATE_CUBE (1)

MDACTION_COORDINATE_DIMENSION (2): refers to the dimensions hierarchies.

MDACTION_COORDINATE_LEVEL (3)

MDACTION_COORDINATE_MEMBER (4)

MDACTION_COORDINATE_SET (5)

MDACTION_COORDINATE_CELL (6)
ACTION_CAPTION DBTYPE_WSTR The action name if no caption was specified and no translations were specified in the DDL.

If a caption or translations were specified, and CaptionIsMDX is false, one of the following strings:

-The translation for the appropriate language.

-The specified caption if no translation was found for the specified language.

-The action name if no translation was found and the caption was not specified in DDL.

If a caption or translations were specified, and CaptionIsMDX is true, the string resulting from finding the appropriate translation for the specified language or the specified translation in the DDL caption, and calculating the formula to create the string.

If the action was specified in MDX Script, there are no translations and the caption is always treated as MDX expression.
DESCRIPTION DBTYPE_WSTR A user-friendly description of the action.
CONTENT DBTYPE_WSTR The expression or content of the action that is to be run.
APPLICATION DBTYPE_WSTR The name of the application that is to be used to run the action.
INVOCATION DBTYPE_I4 Information about how the action should be invoked:

MDACTION_INVOCATION_INTERACTIVE (1) indicates a regular action used during normal operations. This is the default value for this column.

MDACTION_INVOCATION_ON_OPEN (2) indicates that the action should be performed when the cube is first opened.

MDACTION_INVOCATION_BATCH (4) indicates that the action is performed as part of a batch operation or Microsoft SQL Server Integration Services task.



Note that these enumeration values are defined in the file, Msmd.h.

The rowset is sorted on CATALOG_NAME, SCHEMA_NAME, CUBE_NAME, ACTION_NAME.

Note

Actions of MDACTION_TYPE_PROPRIETARY type must provide a value for the APPLICATION column.

Restriction Columns

The MDSCHEMA_ACTIONS rowset can be restricted on the columns listed in the following table.

Column name Type indicator Restriction State
CATALOG_NAME DBTYPE_WSTR Optional
SCHEMA_NAME DBTYPE_WSTR Optional
CUBE_NAME DBTYPE_WSTR Mandatory
ACTION_NAME DBTYPE_WSTR Optional
ACTION_TYPE DBTYPE_I4 Optional
COORDINATE DBTYPE_WSTR Mandatory
COORDINATE_TYPE DBTYPE_I4 Mandatory
INVOCATION DBTYPE_I4 (Optional) The INVOCATION restriction column defaults to the value of MDACTION_INVOCATION_INTERACTIVE. To retrieve all actions, use the MDACTION_INVOCATION_ALL value in the INVOCATION restriction column.
CUBE_SOURCE DBTYPE_UI2 (Optional) Default restriction is a value of 1. A bitmap with one of the following valid values:

1 CUBE

2 DIMENSION

Important

The INVOCATION restriction column has a default value of MDACTION_INVOCATION_INTERACTIVE. Any schema rowset that does not explicitly specify a value for this column contains only rows with this value. If you want the rowset to contain the entire set of actions, use the MDACTION_INVOCATION_ALL constant in the INVOCATION restriction column.

Client applications can define more than one ACTION_TYPE by using the OR operator.

Remarks

The following table lists the valid COORDINATE and COORDINATE_TYPE combinations.

COORDINATE object type COORDINATE_TYPE
Cube MDACTION_COORDINATE_CUBE
Dimension MDACTION_COORDINATE_DIMENSION

MDACTION_COORDINATE_LEVEL

MDACTION_COORDINATE_MEMBER

MDACTION_COORDINATE_SET

MDACTION_COORDINATE_CELL
Hierarchy MDACTION_COORDINATE_DIMENSION
Level MDACTION_COORDINATE_LEVEL
Member MDACTION_COORDINATE_MEMBER
Set MDACTION_COORDINATE_SET
cell MDACTION_COORDINATE_CELL

See Also

OLE DB for OLAP Schema Rowsets