IUiCommandTarget.Execute

Syntax

Execute(Command: String; Context: IUiCommandExecutionContext): Variant;

Parameters

Command. String identifier of the command to be executed.

Context. Advanced parameters of command execution.

Description

The Execute method executes command on an object. To execute a command on an object, call the Execute method by specifying string command identifier and advanced execution parameters (optional).

Comments

All platform commands have unique string identifiers. For example, identifier of the object opening command is Object.Open, object editing command has the Object.Edit identifier, and so on. To view detailed description and examples of use, select a link to a specific command.

General Commands

Commands of various platform objects:

Command Brief description

CalcCube.EditFormulas

It opens a standard dialog box that is used to edit formulas.

CalcCube.Execute

It opens a standard dialog box that is used to start multidimensional calculation at database server.

Cube.CreateReport

It creates a regular report based on a cube.

Cube.SaveToFile

It opens a standard dialog box that is used to save a cube to a file.

Object.Access

It sets up access permissions for the object.

Object.Edit

It edits object properties.

Object.EditShortcut

It edits shortcut properties.

Object.History

It opens a standard dialog box of object history.

Object.Open

It opens an object.

Problem.Run

It starts modeling problem calculation.

Query.QueryBuilder

It opens query designer.

The Adm Plugin

Administration commands:

Command Brief description

ChangePassword

It opens a standard dialog box that is used to change password of the current user.

OpenNavigator

It opens security manager for the specified repository.

ShowUserProp

It opens a standard dialog box that is used to set up user properties.

ShowHoursPolicy

It opens a standard dialog box that is used to distribute system access time for the user.

UpdateUsers_ShowErrorsDialog

It opens a dialog box with user update errors.

The Cubes Plugin

Multidimensional data source commands:

Command Brief description

LoadCubes

It opens a dialog box that is used to import data to a cube.

CopyRubricator

It copies a time series database.

The Db Plugin

Table commands:

Command Brief description

FieldEditor

It opens a standard dialog box that is used to edit table field parameters.

LinkTables

It opens a wizard for creating a linked table.

The DevEnv Plugin

Development environment object commands:

Command Brief description

DebugObject

It starts debugging of the specified development environment object.

The Dim Plugin

Dictionary commands:

Command Brief description

ElementGroupsDialog

It opens the dialog box that is used to set up groups of dictionary elements.

HierarchiesDialog

It opens the dialog box that is used to set up alternative hierarchies of dictionary.

OpenDimension

It opens a dictionary for view.

SelectionSchemasDialog

It opens a dialog box that is used to set up dictionary selection schemas.

The Etl Plugin

ETL task commands:

Command Brief description
ShowConsumerData It opens a dialog box that is used to view ETL task consumer data.
ShowExecutionOrder It opens the dialog box that is used to set up operation execution order in an ETL task.
ShowProviderData It opens a dialog box that is used to view data in an ETL task source.

The Express Plugin

The Analytical Queries (OLAP) tool commands:

Command Brief description

CalculatesSetup

It opens a standard dialog box that is used to set up calculated indicators.

DimSelectionSetup

It creates a selection for express report dimension elements.

FilterSetup

It opens a standard dialog box that is used to set up data filter.

FormatConditionsSetup

It opens a standard dialog box that is used to set up parameters of conditional data formatting.

HighlightSetup

It opens a standard dialog box that is used to set up data highlighting.

OpenCube

It creates an express report on cube basis and opens it for view.

OpenFile

It opens an express report saved to the file (Express Report > Open from File).

OpenRubricator

It creates an express report based on a time series database and then opens it for review.

ParetoSetup

It opens a standard dialog box that is used to set up 80/20 analysis parameters.

PerformSearch

It opens a standard dialog box that is used to find an object in express report table.

ShowBulkExportDialog

It opens a standard dialog box of batch export.

ShowBulkPrintDialog

It opens a standard dialog box of batch print.

ShowCalcChaingDialog

It displays the standard dialog box of calculation chain.

ShowFormulaEditor

It displays the standard dialog box of the expression editor to set up a dimension element.

ShowReporter

It opens an express report.

TableFormatSetup

It opens a standard dialog box that is used to set up style used for various table areas.

TableStyleSetup

It opens a standard dialog box that is used to set up style used for table data area.

TotalsSetup

It opens a special dialog box that is used to set up totals.

The FactRubricator Plugin

The Time Series Analysis tool commands:

Command Brief description

ShowDataMiningDialog

It opens a data mining dialog box.

ShowExplainValidationDialog

It opens a dialog box to explain validation errors for the selected cell.

ShowExportDialog

It starts the wizard to start the current or create a new export object in the time series database.

ShowImportDialog

It starts the wizard that is used to start the current or create a new import object based on a time series database.

The Fld Plugin

Repository object commands:

Command Brief description

ShowCreateShortcut

It opens a standard dialog box for creating an repository object shortcut.

ShowObjectAccess

It opens a standard dialog box for setting up access control parameters for a repository object.

ShowObjectProps

It opens a standard dialog box with repository object properties.

The MetabaseUpdate Plugin

The Update Manager tool commands:

Command Brief description

ApplyUpdate

It starts update installation wizard.

CreateUpdate

It opens update manager to create a new update.

OpenUpdate

It opens update from a file in the platform update manager.

OpenUpdateFromRepo

It opens update from a repository in the platform update manager.

The Ms Plugin

The Modeling and Forecasting tool commands:

Command Brief description
CopyModelSpace It copies modeling container.
EditChainEntry It opens the dialog box to set up multidimensional cycle or the dialog box to set up multidimensional cycle dimension.

EditMatrixAggregationFilter

It opens the dialog box to set up dimension filtering on determining calculation parameters of matrix aggregation.

GetCubeModelDesc

It determines a time series database or a cube that contain a modeling object.

GetRubricatorDesc

It determines a time series database that contains a modeling object.

ShowAdditionalAttributesDialog It opens the dialog box to set values of additional attributes.
ShowDataMiningWizard It opens the Data Mining tool.

The Rds Plugin

MDM dictionary commands:

Command Brief description

EditDictionary

It opens an MDM dictionary for edit.

EditDictionaryAttribute

It opens a dialog box for editing attribute parameters of MDM dictionary.

OpenDictionary

It opens an MDM dictionary for view.

The Report Plugin

The Reports tool commands:

Command Brief description

ChartExternLegendSetup

It opens a standard dialog box that is used to set up parameters of the legend created for regular report charts.

CreateFastReport

It creates regular report based on the selected time series database.

DataIslandSetup

It opens a standard dialog box that is used to set up data area parameters.

FormatConditionSetup

It opens a standard dialog box that is used to set up parameters of the specified conditional format.

FormatConditionsSetup

It opens a standard dialog box that is used to set up conditional format parameters.

FormulaIslandSetup

It opens a standard dialog box that is used to set up formula area.

InsertSheetDialog

It opens a standard dialog box that is used to add a sheet.

MapLegendSetup

It opens a standard dialog box that is used to set up parameters of the map legend located on one of the sheets of regular report.

MapSetup

It opens a standard dialog box that is used to set up parameters of the map located on one of the sheets of regular report.

MapTerritoryInfoSetup

It opens a standard dialog box that is used to set up parameters of the map territory info located on one of the sheets of regular report.

MoveCopySheet

It opens a standard dialog box that is used to copy/move sheets.

NamedRangesSetup

It opens a dialog box that is used to set up named ranges.

ObjectProperties

It opens a standard dialog box that is used to set up object or sheet objects properties.

PerformSearch

It opens a standard dialog box that is used to find or replace an object in a regular report.

Scene3DSetup

It opens a standard dialog box that is used to set up 3D scene parameters.

SetupSliceDimsTable

It opens a standard dialog box that is used to set up data slice dimensions.

SheetProperties

It opens a standard dialog box that is used to set up sheet properties.

SheetProtection

It opens a standard dialog box that is used to protect a sheet.

ShowAttachmentsDialog

It opens a standard dialog box to work with cell attachments.

ShowBulkExportDialog

It opens a standard dialog box for batch export of a regular report.

ShowBulkExportDialogEx

It opens a standard dialog box for batch export of a regular report including options to set additional parameters for dialog box opening.

ShowBulkPrintDialog

It opens a standard dialog box that is used to set up batch export of a regular report.

ShowBulkPrintDialogEx

It opens a standard dialog box that is used to set up batch export of regular report including options to set additional parameters for dialog opening.

ShowDataAdapterDialog

It opens a standard dialog box that is used to set up parameters of data adapter for different elements of a regular report map.

ShowDependenciesDialog

It opens a standard dialog box that is used to set up dependencies.

ShowExportPropSetup

It opens a dialog box that is used to set up export parameters in the regular report calculation task.

ShowFormulaDialog

It opens the functions wizard of a regular report.

ShowMapLayerSelectionDialog

It opens a dialog box to select map structure.

ShowPrxControlPropDialog

It opens a dialog box that is used to set up properties of a control.

ShowReporter

It opens a regular report or creates a new report not connected to the repository.

ShowScalePropsDialog

It opens a standard dialog box that is used to edit regular report scales.

TableStyleSetup

It creates a new table style and opens a standard style setup dialog box.

TableStylesSetup

It opens a standard dialog box that is used to set up table styles.

The Std Plugin

Object navigator commands:

Command Brief description

CreateCustomClass

It opens the dialog box to create a new custom class.

EditCustomClass

It opens a dialog box for editing the existing custom class.

OpenLoginDialog

It opens a dialog box for repository connection.

OpenNavigator

It opens a repository in the object navigator.

SelectSecSubject

It opens a standard dialog box that is used to select security subjects.

ShowFindObjects

It searches for repository objects according to the specified parameters and displays found objects in the object navigator.

ShowMetabaseFolder

It moves focus to the object navigator and shows contents of the specified container object.

ShowMetabaseObject

It moves focus to the object navigator and shows the specified repository object.

The Wsp Plugin

The Workspace tool commands:

Command Brief description

ShowStyleDialog

It opens a standard dialog box that is used to set up format of workspace objects.

See also:

IUiCommandTarget