MDSCHEMA_ACTIONS

Analysis Services Programming

Analysis Services Programming

MDSCHEMA_ACTIONS

This schema rowset describes the actions that may be available to the client application.

Microsoft® SQL Server™ 2000 Analysis Services extends the OLE DB specification with the addition of the MDSCHEMA_ACTIONS schema rowset. The following table describes this schema rowset.

Column name Type indicator Description
CATALOG_NAME DBTYPE_WSTR The name of the catalog to which this action belongs.
SCHEMA_NAME DBTYPE_WSTR This column is not supported by Analysis Services; it always contains VT_NULL.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 following bit value constants are defined in Msmd.h for this bitmap:
  • MDACTION_TYPE_URL
  • MDACTION_TYPE_HTML

  • MDACTION_TYPE_STATEMENT

  • MDACTION_TYPE_DATASET

  • MDACTION_TYPE_ROWSET

  • MDACTION_TYPE_COMMANDLINE

  • MDACTION_TYPE_PROPRIETARY
COORDINATE DBTYPE_WSTR A Multidimensional Expressions (MDX) expression that specifies an object or a coordinate in the multidimensional space in which the action is executed. It is the responsibility of the client application to provide the value of this restriction column.
COORDINATE_TYPE DBTYPE_I4 A bitmap that specifies how the COORDINATE restriction column is interpreted. The following bit value constants are defined in Msmd.h for this bitmap:
  • MDACTION_COORDINATE_CUBE

  • MDACTION_COORDINATE_DIMENSION

  • MDACTION_COORDINATE_LEVEL

  • MDACTION_COORDINATE_MEMBER

  • MDACTION_COORDINATE_SET

  • MDACTION_COORDINATE_CELL
ACTION_CAPTION DBTYPE_WSTR The label or a caption associated with this action.
DESCRIPTION DBTYPE_WSTR A user-friendly description of the action.
CONTENT DBTYPE_WSTR The expression or content of the action that is to be executed.
APPLICATION DBTYPE_WSTR The name of the application that is to be used to execute the action.
INVOCATION DBTYPE_I4 Provides information about how the action should be invoked:
  • MDACTION_INVOCATION_INTERACTIVE

    Regular action used during normal operations. This is the default value for this column.

  • MDACTION_INVOCATION_ON_OPEN

    Action should be executed when the cube is first opened.

  • MDACTION_INVOCATION_BATCH

    Action executes as part of a batch operation or DTS task.

These enumeration values are defined in MSMD.h.


The sort order for this schema rowset is the same as the definition for this schema rowset.

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

Restriction Columns

The actions schema rowset contains three mandatory restrictions that must be specified when retrieving a schema rowset. Failing to specify a mandatory restriction column results in an error. The following table contains a list of restriction columns and describes whether they are mandatory.

Column name Restriction state
CATALOG_NAME Optional
SCHEMA_NAME Optional
CUBE_NAME Mandatory
ACTION_NAME Optional
ACTION_TYPE Optional
COORDINATE Mandatory
COORDINATE_TYPE Mandatory
INVOCATION Optional

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.

See Also

Actions

CREATE ACTION Statement