AnalysisRun Action Parameters

name

The name of the analysis to be executed.

This parameter is mandatory.

scope

Defines which kind of analysis is to be used if two analyses with the same name exist: Public or Private.

autoStart

If set to true, the analysis is automatically executed.

chartType

Specify the name of a chart type (e.g. Bar3D) determining the default chart type selection on the Analysis page. It can be changed by the user. For further details, see Chart Types.

fixedChartType

Determines the chart type to be displayed. It cannot be changed by the user. For further details, see Chart Types.

link/linkId

Defines the context for the analysis' execution: The uid of a record to be used as link record when executing the analysis.

Use linkId (optional) to specify another than the default link.

headerName

Name of an optional special header to be displayed.

showGrid

If set to false, the Show Table button is hidden from the Analysis page.

showChart

If set to false, the Show Chart button is hidden from the Analysis page.

showSettings

If set to true, the settings editor is displayed on the Analysis page allowing users to modify the analysis. Use showCategory, showValues, showCurrency and showFilters. Ssee below sections to show/hide single elements of the settings editor.

showSettings overrules collapseSettingsEditor. For further details, see collapseSettingsEditor.

view

Determines the initial view of the Analysis page: grid or chart.

showCategory

If set to false, the Category area is hidden from the settings editor.

showValues

If set to false, the Values area is hidden from the settings editor.

showCurrency

If set to false, the Currency area is hidden from the settings editor.

showFilters

If set to false, the Filter area is hidden from the settings editor.

showChartLegend

If set to true, the Show Legend check box is checked by default.

showChartValues

If set to true, the Show Values check box is checked by default.

hideSelector

If set to false, the chart selector is hidden from the analysis page.

collapseSettingsEditor

Defines the initial state of the settings editor: If set to true, the settings editor is initially hidden.

showSettings overrules collapseSettingsEditor. For further details, see showSettings.

Default: false.

pageSize

Use/add this parameter to determine the number of result rows displayed in the table view of an analysis result page.

Default: 10.