Share via


2.2.4.2.2.9.5 Action

This complex type represents an action.

Action is an abstract type, and types for derived Action types are derived from it. Therefore, the XSD for action does not show the elements; instead they are shown within the XSD of each of the derived types. However, all the elements in the base type are explained in the table in this section.

   <xsd:complexType name="Action" abstract="true" />

Element

Read-Only

Default value

Description

Name

[Required]

The object name.

ID

Defaults to Name

The object ID string.

Caption

Empty

The caption displayed for the action. Can be an MDX expression.

CaptionIsMdx

False

When true, specifies that the caption is an MDX expression; otherwise, false.

Translations

Empty

A collection of Translation objects.

TargetType

[Required]

The type of object to which this Action applies. Such objects are limited to those in the enumeration that is specified in the XSD. The following objects are allowed:

  • "Cube": A Cube object.

  • "Cells": A subcube. Subcubes are created by using MDX [MSDN-CREATESUBCUBE].

  • "Set": A set. Sets are created by using MDX [MSDN-CREATESET].

  • "Hierarchy": A Hierarchy object.

  • "Level": A Level object.

  • "DimensionMembers": The members of a Dimension.

  • "HierarchyMembers": The members of a Hierarchy.

  • "LevelMembers": The members of a Level.

  • "AttributeMembers": The members of a DimensionAttribute.

Target

Empty

Identifies the target for this Action. The specified Target MUST be an object of type TargetType.

Condition

Empty

An MDX expression that determines if the action applies. If false, the action does not apply.

Type

[Required]

The type of action. The following values are allowed:

  • "Url" – Opens a URL string in an Internet browser.

  • "Html" – Renders an HTML script in an Internet browser.

  • "Statement" – Executes a statement that is understood by the client application.

  • "DrillThrough" - See DrillThroughAction.

  • "Dataset" – Executes an MDX statement whose results are returned as a dataset.

  • "Rowset" – Executes an MDX statement whose results are returned as a rowset.

  • "CommandLine" – Executes a command.

  • "Proprietary" – Executes an action whose structure is understood by a particular proprietary client application.

  • "Report" – See ReportAction.

The DrillThrough type can be defined only with actions where the target type is Cells. The DrillThrough type is referenced in the MDSCHEMA_ACTIONS schema rowset, Action_Type column, as a Rowset action (0x010). The report action is exposed in the MDSCHEMA_ACTIONS schema rowset, Action_Type column, as a URL action(0x01). Note that for the derived types ReportAction and DrillThroughAction, this value MUST be set to "Report" and "DrillThrough", respectively.

Invocation

Empty

An enumeration value that determines how the action is invoked.

Application

Empty

Identifies the application associated with an Action element.

Description

Empty

The object description.

Annotations

Empty

A collection of Annotation objects.