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	Opens a standard dialog box that is used to edit formulas.
CalcCube.Execute	Opens a standard dialog box that is used to start multidimensional calculation at database server.
Cube.CreateReport	Creates a regular report based on a cube.
Cube.SaveToFile	Opens a standard dialog box that is used to save a cube to a file.
Object.Access	Setting up access permissions for the object.
Object.Edit	Edits object properties.
Object.EditShortcut	Edits shortcut properties.
Object.History	Opens a standard dialog box of object history.
Object.Open	Opens an object.
Problem.Run	Starts modeling problem calculation.
Query.QueryBuilder	Opens query designer.

Adm Plugin

Administration commands:

Command	Brief description
ChangePassword	Opens a standard dialog box that is used to change password of the current user.
OpenNavigator	Opens security manager for the specified repository.
ShowUserProp	Opens a standard dialog box that is used to set up user properties.
ShowHoursPolicy	Opens a standard dialog box that is used to distribute system access time for the user.
UpdateUsers_ShowErrorsDialog	Opens a dialog box with user update errors.

Cubes Plugin

Multidimensional data source commands:

Command	Brief description
LoadCubes	Opens a dialog box that is used to import data to a cube.
CopyRubricator	Copies a time series database.

Db Plugin

Table commands:

Command	Brief description
FieldEditor	Opens a standard dialog box that is used to edit table field parameters.
LinkTables	Opens a wizard for creating a linked table.

DevEnv Plugin

Development environment object commands:

Command	Brief description
DebugObject	Starts debugging of the specified development environment object.

Dim Plugin

Dictionary commands:

Command	Brief description
ElementGroupsDialog	Opens the dialog box that is used to set up groups of dictionary elements.
HierarchiesDialog	Opens the dialog box that is used to set up alternative hierarchies of dictionary.
OpenDimension	Opens a dictionary for view.
SelectionSchemasDialog	Opens a dialog box that is used to set up dictionary selection schemas.

Etl Plugin

ETL task commands:

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

Express Plugin

The Analytical Queries (OLAP) tool commands:

Command	Brief description
CalculatesSetup	Opens a standard dialog box that is used to set up calculated factors.
DimSelectionSetup	Creates a selection for express report dimension elements.
FilterSetup	Opens a standard dialog box that is used to set up data filter.
FormatConditionsSetup	Opens a standard dialog box that is used to set up parameters of conditional data formatting.
HighlightSetup	Opens a standard dialog box that is used to set up data highlighting.
OpenCube	Creates an express report on cube basis and opens it for view.
OpenFile	Opens an express report saved to the file (Express Report > Open from File).
OpenRubricator	Creates an express report based on a time series database and then opens it for review.
ParetoSetup	Opens a standard dialog box that is used to set up 80/20 analysis parameters.
PerformSearch	Opens a standard dialog box that is used to find an object in express report table.
ShowBulkExportDialog	Opens a standard dialog box of batch export.
ShowBulkPrintDialog	Opens a standard dialog box of batch print.
ShowCalcChaingDialog	Displays the calculation chain.
ShowFormulaEditor	Displays the standard dialog box of the expression editor to set up a dimension element.
ShowReporter	Opens an express report.
TableFormatSetup	Opens a standard dialog box that is used to set up style used for various table areas.
TableStyleSetup	Opens a standard dialog box that is used to set up style used for table data area.
TotalsSetup	Opens a special dialog box that is used to set up totals.

FactRubricator Plugin

The Time Series Analysis tool commands:

Command	Brief description
ShowDataMiningDialog	Opens a data mining dialog box.
ShowExplainValidationDialog	Opens a dialog box to explain validation errors for the selected cell.
ShowExportDialog	Starts the wizard to start the current or create a new export object in the time series database.
ShowImportDialog	Starts the wizard that is used to start the current or create a new import object based on a time series database.

Fld Plugin

Repository object commands:

Command	Brief description
ShowCreateShortcut	Opens a standard dialog box that is used to create an object repository shortcut.
ShowObjectAccess	Opens a standard dialog box that is used to set up access control parameters for a repository object.
ShowObjectProps	Opens a standard dialog box of repository object properties.

MetabaseUpdate Plugin

The Update Manager tool commands:

Command	Brief description
ApplyUpdate	Starts update installation wizard.
CreateUpdate	Opens update manager to create a new update.
OpenUpdate	Opens update from a file in the platform update manager.
OpenUpdateFromRepo	Opens update from a repository in the platform update manager.

Mobile Plugin

Mobile application container commands:

Command	Brief description
Publish	Opens mobile application publishing wizard.

Modeller Plugin

Express modeling commands:

Command	Brief description
ShowModeller	Opens express modeling dialog box for express report data.

Ms Plugin

The Modeling and Forecasting tool commands:

Command	Brief description
CopyModelSpace	Copies modeling container.
EditChainEntry	Opens the dialog box to set up multidimensional cycle or the dialog box to set up multidimensional cycle dimension.
GetCubeModelDesc	Determines a time series database or a cube that contain a modeling object.
GetRubricatorDesc	Determines a time series database that contains a modeling object.
ShowAdditionalAttributesDialog	Opens the dialog box to set values of additional attributes.
ShowDataMiningWizard	Opens the Data Mining tool.

Rds Plugin

MDM dictionary commands:

Command	Brief description
EditDictionary	Opens an MDM dictionary for edit.
EditDictionaryAttribute	Opens a dialog box for editing attribute parameters of MDM dictionary.
OpenDictionary	Opens an MDM dictionary for view.

Report Plugin:

The Reports tool commands:

Command	Brief description
ChartExternLegendSetup	Opens a standard dialog box that is used to set up parameters of the legend created for regular report charts.
CreateFastReport	Creates regular report based on the selected time series database.
DataIslandSetup	Opens a standard dialog box that is used to set up data area parameters.
FormatConditionSetup	Opens a standard dialog box that is used to set up parameters of the specified conditional format.
FormatConditionsSetup	Opens a standard dialog box that is used to set up conditional format parameters.
FormulaIslandSetup	Opens a standard dialog box that is used to set up formula area.
InsertSheetDialog	Opens a standard dialog box that is used to add a sheet.
MapLegendSetup	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	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	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	Opens a standard dialog box that is used to copy move sheets.
NamedRangesSetup	Opens a dialog box that is used to set up named ranges.
ObjectProperties	Opens a standard dialog box that is used to set up object or sheet objects properties.
PerformSearch	Opens a standard dialog box that is used to find or replace an object in a regular report.
Scene3DSetup	Opens a standard dialog box that is used to set up 3D scene parameters.
SetupSliceDimsTable	Opens a standard dialog box that is used to set up data slice dimensions.
SheetProperties	Opens a standard dialog box that is used to set up sheet properties.
SheetProtection	Opens a standard dialog box that is used to protect a sheet.
ShowBulkExportDialog	Opens a standard dialog box for batch export of a regular report.
ShowBulkExportDialogEx	Opens a standard dialog box for batch export of a regular report including options to set additional parameters for dialog box opening.
ShowBulkPrintDialog	Opens a standard dialog box that is used to set up batch export of a regular report.
ShowBulkPrintDialogEx	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	Opens a standard dialog box that is used to set up parameters of data adapter for different elements of a regular report map.
ShowDependenciesDialog	Opens a standard dialog box that is used to set up dependencies.
ShowExportPropSetup	Opens a dialog box that is used to set up export parameters in the regular report calculation task.
ShowFormulaDialog	Opens the functions wizard of a regular report.
ShowMapLayerSelectionDialog	Opens a dialog box to select map structure.
ShowPrxControlPropDialog	Opens a dialog box that is used to set up properties of a control.
ShowReporter	Opens a regular report or creates a new report not connected to the repository.
ShowScalePropsDialog	Opens a standard dialog box that is used to edit regular report scales.
TableStyleSetup	Creates a new table style and opens a standard style setup dialog box.
TableStylesSetup	Opens a standard dialog box that is used to set up table styles.

Std Plugin

Object navigator commands:

Command	Brief description
CreateCustomClass	Opens the dialog box to create a new custom class.
EditCustomClass	Calling a dialog box for editing the existing custom class.
OpenLoginDialog	Opens a dialog box for repository connection.
OpenNavigator	Opens a repository in the object navigator.
SelectSecSubject	Opens a standard dialog box that is used to select security subjects.
ShowFindObjects	Searches repository objects according to the specified parameters and displays found objects in the object navigator.
ShowMetabaseFolder	Moves focus to the object navigator and shows contents of the specified container object.
ShowMetabaseObject	Moves the focus to the object navigator and shows the specified repository object.

Wsp Plugin

The Workspace tool commands:

Command	Brief description
ShowStyleDialog	Opens a standard dialog box that is used to set up format of workspace objects.