/sap-sac-scripting

OSE API: Data & DataSource

Version: 2025.20 | SAC Release: Q2 2026 (2026.8) | Full API Docs: SAP Help Portal

Data access and management: DataSource API, data actions, data binding, data change insights, data locking, and file/external data sources.

Classes in This File

• BatchExportDataSource
• BpcPlanningSequenceDataSource
• CommentingDataSource
• DataAction
• DataActionAllMemberSelection
• DataActionBackgroundExecutionResponse
• DataActionBackgroundExecutionResponseStatus
• DataActionExecutionResponse
• DataActionExecutionResponseStatus
• DataActionMemberParameterValue
• DataActionNumberParameterValue
• DataActionParameterValue
• DataActionParameterValueType
• DataActionPlanningModelMemberParameterValue
• DataActionTrigger
• DataBinding
• DataBindings
• DataCell
• DataChangeInsight
• DataChangeInsights
• DataChangeInsightsComparisonOptions
• DataChangeInsightsResult
• DataChangeInsightsStatus
• DataChangeInsightsSubscriptionLevel
• DataChangeInsightsSubscriptionRange
• DataChangeInsightType
• DataContext
• DataLocking
• DataLockingState
• DataSource
• DataSourceComments
• DataSourceInfo
• DataUploadExecutionResponseStatus
• DataUploadFileHandler
• DataUploadStarter
• DataUploadStatistics
• FileDataSource
• InputControl
• InputControlDataSource
• ODataError
• ODataQueryOptions
• RDataFrame

<a name="batchexportdatasource"></a>

BatchExportDataSource

Since

2024.7

Last Update

2024.17

Method Summary

Method Detail

Sets a filter on the dimension. The filter will be used in batch export. Only dimension member and range filter is supported.

Parameters

Last Update

2024.17 |

Type Library bookmark

C

<a name="bpcplanningsequencedatasource"></a>

BpcPlanningSequenceDataSource

Since

2022.14

Last Update

2022.16

Method Summary

Method Detail

Copies the value of a variable. If no variable is specified, then all variable values of the data source are copied. If you copy an empty variable value to a mandatory variable, then copying this variable is ignored.

Parameters

Last Update

2022.16 |

Returns the values of the variable. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function. Note: This method may return outdated values with SAP BW dynamic filter variables.

Parameters

Returns

VariableValue[]

Last Update

2022.16 |

Removes the value of the variable. By default, this removes the variable value of the variable for the data source on the application. If you remove a variable value from a mandatory variable, then this operation is ignored.

Parameters

Last Update

2022.16 |

Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set an empty variable value to a mandatory variable, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.

Parameters

Last Update

2022.16 |

Type Library planning

C

<a name="commentingdatasource"></a>

CommentingDataSource

Since

2021.5

Method Summary

Method Detail

Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.

Parameters

Returns

FilterValue[] |

Removes any filter that is set on the dimension. Advanced Filters aren't affected.

Parameters

Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or more members to be included in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter.

Parameters

Type Library containers

C

<a name="dataaction"></a>

DataAction

Since

2021.6

Last Update

2024.4

Method Summary

Event Summary

Method Detail

Executes the data action as a non-blocking operation. A non-blocking operation doesn't block further execution while that operation is executed.

Parameters

Returns

DataActionBackgroundExecutionResponse

Since

2022.12 |

Returns status of given Data Action execution.

Parameters

Returns

DataActionExecutionResponseStatus

Since

2024.4 |

Returns the value of the parameter.

Parameters

Returns

DataActionParameterValue |

Returns whether the parameter has the all member as value.

Parameters

Returns

boolean

Since

2023.20 |

Sets the all member as parameter value.

Parameters

Since

2023.20 |

Sets the value of the parameter.

Parameters

Event Detail

Called when an asynchronous Data Action execution changes its status.

Parameters

Since

2022.12 |

Type Library data-action

C

<a name="dataactionallmemberselection"></a>

DataActionAllMemberSelection

extends DataActionParameterValue, can be passed as a JSON object to method arguments

An object defining a data action parameter all member selection

Since

2023.20

Property Summary

Property Detail

Type Library data-action

C

<a name="dataactionbackgroundexecutionresponse"></a>

DataActionBackgroundExecutionResponse

Since

2022.12

Property Summary

Property Detail

Type Library data-action

E

<a name="dataactionbackgroundexecutionresponsestatus"></a>

DataActionBackgroundExecutionResponseStatus

Since

2022.12

Last Update

2022.15

Property Summary

Property Detail

Type Library data-action

C

<a name="dataactionexecutionresponse"></a>

DataActionExecutionResponse

Since

2021.6

Property Summary

Property Detail

Type Library data-action

E

<a name="dataactionexecutionresponsestatus"></a>

DataActionExecutionResponseStatus

Since

2021.6

Last Update

2024.4

Property Summary

Property Detail

Type Library data-action

C

<a name="dataactionmemberparametervalue"></a>

DataActionMemberParameterValue

extends DataActionParameterValue, can be passed as a JSON object to method arguments

An object defining a data action member parameter value

Since

2021.6

Property Summary

Property Detail

Type Library data-action

C

<a name="dataactionnumberparametervalue"></a>

DataActionNumberParameterValue

extends DataActionParameterValue, can be passed as a JSON object to method arguments

An object defining a data action number parameter value

Since

2021.6

Property Summary

Property Detail

Type Library data-action

C

<a name="dataactionparametervalue"></a>

DataActionParameterValue

can be passed as a JSON object to method arguments

An object defining a data action parameter value

Direct Subclasses

DataActionAllMemberSelection, DataActionMemberParameterValue, DataActionNumberParameterValue, DataActionPlanningModelMemberParameterValue

Since

2021.6

Property Summary

Property Detail

Type Library data-action

E

<a name="dataactionparametervaluetype"></a>

DataActionParameterValueType

Since

2021.6

Last Update

2024.20

Property Summary

Property Detail

C

<a name="dataactionplanningmodelmemberparametervalue"></a>

DataActionPlanningModelMemberParameterValue

extends DataActionParameterValue, can be passed as a JSON object to method arguments

An object defining a data action member parameter value

Since

2024.20

Property Summary

Property Detail

Type Library planning

C

<a name="dataactiontrigger"></a>

DataActionTrigger

extends Widget

Since

2018.22

Last Update

2020.4

Method Summary

Event Summary

Event Detail

Type Library data-binding

C

<a name="databinding"></a>

DataBinding

Since

2022.8

Last Update

2023.15

Method Summary

Method Detail

Adds a dimension to a feed.

Parameters

Adds a member to a feed.

Parameters

Returns all dimensions on the feed.

Parameters

Returns

string[] |

Returns all members on the feed.

Parameters

Returns

string[] |

Removes a dimension from the feed on which it is currently on.

Parameters

Removes a member from the feed on which it is currently on.

Parameters

Sets the model and replaces the old one.

Parameters

Returns

boolean |

Type Library data-binding

C

<a name="databindings"></a>

DataBindings

Since

2022.8

Method Summary

Method Detail

Returns the databinding of the custom widget. If arugment is omitted, the first databinding defined in the contribution will be returned. If the customwidget has no databinding, then undefined is returned.

Parameters

Returns

DataBinding |

Type Library datasource

C

<a name="datacell"></a>

DataCell

Property Summary

Property Detail

Type Library data-change-insights

C

<a name="datachangeinsight"></a>

DataChangeInsight

Since

2021.1

Property Summary

Property Detail

Type Library data-change-insights

C

<a name="datachangeinsights"></a>

DataChangeInsights

Since

2021.1

Last Update

2021.5

Method Summary

Method Detail

Compares the current state of the analytic application with a Data Change Insights snapshot.

Parameters

Returns

DataChangeInsightsResult |

Compares two Data Change Insights snapshots by date. Note: An analytic application can have only one Data Change Insights snapshot per day.

Parameters

Returns

DataChangeInsightsResult |

Returns a list of dates when a Data Change Insights snapshot was created from the analytic application. Optionally, you can specify the maximum number of returned dates (default: 10 for Local Tenant Storage, 100 for Data Repositories). The maximum number is limited to 10 for Local Tenant Storage, 100 for Data Repositories.

Parameters

Returns

Date[] |

Type Library data-change-insights

C

<a name="datachangeinsightscomparisonoptions"></a>

DataChangeInsightsComparisonOptions

can be passed as a JSON object to method arguments

Since

2021.1

Property Summary

Property Detail

Type Library data-change-insights

C

<a name="datachangeinsightsresult"></a>

DataChangeInsightsResult

Since

2021.1

Property Summary

Property Detail

Type Library data-change-insights

E

<a name="datachangeinsightsstatus"></a>

DataChangeInsightsStatus

Since

2021.1

Property Summary

Property Detail

Type Library chart

E

<a name="datachangeinsightssubscriptionlevel"></a>

DataChangeInsightsSubscriptionLevel

Since

2021.5

Property Summary

Property Detail

Type Library chart

C

<a name="datachangeinsightssubscriptionrange"></a>

DataChangeInsightsSubscriptionRange

can be passed as a JSON object to method arguments

Since

2021.5

Property Summary

Property Detail

Type Library data-change-insights

E

<a name="datachangeinsighttype"></a>

DataChangeInsightType

Since

2021.1

Property Summary

Property Detail

Type Library datasource

C

<a name="datacontext"></a>

DataContext

A data context describes a member or measure. For example, a data context of a member is {"id": "[Date_703i1904sd].[YHQM].[Date_703i1904sd.YEAR].[2014]", "description": "2014", "parentId": "[Date_703i1904sd].[YHQM].[All].[(all)]", properties: {}}. For example, a data context of a measure is {"id": "[Account_BestRunJ_sold].[parentId].&[Discount]", "description": "Discount", "formattedValue": "45674567", "rawValue": "45674567"}.

Since

2019.20

Last Update

2020.10

Property Summary

Property Detail

Type Library planning

C

<a name="datalocking"></a>

DataLocking

Since

2019.22

Method Summary

Method Detail

Returns the data locking state of a data cell. The data cell is specified by the selection.

Parameters

Returns

DataLockingState |

Sets the data locking state of a data cell. The data cell is specified by the selection. If this operation was successful, then true is returned, and false if it wasn't.

Parameters

Returns

boolean |

Type Library planning

E

<a name="datalockingstate"></a>

DataLockingState

Since

2019.22

Property Summary

Property Detail

Type Library datasource

C

<a name="datasource"></a>

DataSource

Last Update

2024.20

Method Summary

Method Detail

Collapses a hierarchy node. The dimension node specified by the selection is collapsed. For tables, only one dimension node is collapsed. The expansion state of its child nodes is restored when this dimension node is expanded again. For charts, all specified dimension nodes are collapsed, along with their child nodes. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.

Parameters

Since

2020.11 |

Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. If no dimensions are specified, then the filters of all matching dimensions are copied. Note: Only filters on dimensions with the same name and the same active hierarchy in both the source data source and this data source are copied. Note: Advanced Filters are not copied.

Parameters

Last Update

2019.7 |

Copies the value of a variable. If no variable is specified, then all variable values of the data source are copied. If you copy an empty variable value to a mandatory variable, then copying this variable is ignored. If you copy a variable value to a data source of a widget that overrides variables and the variable is of type text, then copying this variable is ignored.

Parameters

Since

2020.3 |

Expands a hierarchy node. Only one hierarchy dimension can be expanded. Every node on the hierarchy path is expanded as well. For tables, this operation is ignored if one of the dimension nodes on the hierarchy path doesn't exist. Invalid dimensions in the selection are ignored. For charts, all dimension nodes specified by the selection are expanded. If the selection doesn't specify dimension nodes of the specified dimension, then this operation is ignored. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.

Parameters

Since

2020.11 |

Gets a BEx condition by its ID. Note: Only supported for data sources associated with charts.

Parameters

Returns

BackendCondition

Since

2024.20 |

Returns the data cell of the selection. If no value is available for that selection, then undefined is returned. See also the documentation of Selection.

Parameters

Returns

DataCell

Last Update

2019.7 |

Returns selections of data cells. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a selection including all data cells is returned. See also the documentation of Selection or SelectionContext.

Parameters

Returns

Selection[]

Since

2019.20

Last Update

2020.6 |

Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.

Parameters

Returns

FilterValue[]

Since

2020.13 |

Returns the properties of the dimension. Note: Currently, this operation is only supported for data sources associated with tables.

Parameters

Returns

DimensionPropertyInfo[]

Since

2020.7 |

Returns all hierarchies of the dimension.

Parameters

Returns

HierarchyInfo[]

Last Update

2019.7 |

Returns the hierarchy set on the dimension.

Parameters

Returns

HierarchyInfo

Last Update

2019.7 |

Returns the hierarchy level of the dimension. This operation is only supported for data sources associated with tables, charts and optimized geo map bubble color. If the dimension is invalid or if the dimension doesn't have a hierarchy, then undefined is returned. Note: This operation isn't supported for data sources associated with charts on SAP BW models and undefined is returned. For non-active dimensions this operation is only supported for data sources associated with charts in optimized view mode.

Parameters

Returns

integer

Since

2020.11 |

Returns the member info object from a member ID. Note: The member ID of a member may differ depending on its dimension's hierarchy. For example, for a SAP BW system, the member ID of the same member may be "DE" for a flat presentation hierarchy and "!DE" for an actual hierarchy. Note: If the specified hierarchy doesn't exist, then undefined is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation), then undefined is returned. Note: returns compounded displayId if available.

Parameters

Returns

MemberInfo

Since

2021.1 |

Returns the display mode for members of the dimension.

Parameters

Returns

MemberDisplayMode

Since

2019.1

Last Update

2019.7 |

Returns the members of the dimension. If you specify a number, then at most this many members are returned (default: 200). If you specify members options, then you can control the returned set of members even finer. Note: If the hierarchy specified in the members options doesn't exist, then an empty array is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation) in the members options, then an empty array is returned. Note: returns compounded displayId if available.

Parameters

Returns

MemberInfo[]

Last Update

2021.1 |

Returns the result member. It is specified by a dimension and a selection.

Parameters

Returns

ResultMemberInfo

Since

2019.20 |

Returns result sets. The result sets are specified by selections. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a result set including all data is returned. See also the documentation of Selection or SelectionContext.

Parameters

Returns

ResultSet[]

Since

2019.20

Last Update

2020.6 |

Returns the values of the variable. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function. Note: This method may return outdated values with SAP BW dynamic filter variables. Use getDimensionFilters() instead if you are interested in their current values.

Parameters

Returns

VariableValue[]

Since

2020.13 |

Removes any filter that is set on the dimension. Advanced Filters aren't affected.

Parameters

Last Update

2019.7 |

Removes the value of the variable. By default, this removes the variable value of the variable for the data source on the application. If you remove the variable value of a variable for a data source of a widget that overrides variables, then this operation removes only the variable value for this widget. If you remove a variable value from a mandatory variable, then this operation is ignored. If you remove a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored.

Parameters

Since

2020.3 |

Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. Note that for charts, the exclude option doesn't support Alias.MeasureDimension from SAP BW models. For date and time based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. If the dimension has a hierarchy, then the specified members need to be part of this hierarchy. If they belong to a different hierarchy, then set that hierarchy with DataSource.setHierarchy() first before calling DataSource.setDimensionFilter().

Parameters

Last Update

2020.7 |

Sets the hierarchy on the dimension. Note: Currently, this operation is ignored for measure structures. This operation is not supported for data sources associated with geo map layers.

Parameters

Last Update

2019.7 |

Sets the hierarchy level of the dimension. If the dimension or the hierarchy level of the dimension is invalid, then this operation is ignored. The default value of the level is defined by the dimension's default level. For data sources associated with charts, the level value is optional.

Parameters

Since

2020.11 |

Sets the display mode for members of the dimension.

Parameters

Since

2019.1

Last Update

2019.7 |

Sets the pause mode of the data refresh. The script is fully executed without waiting for all the widgets associated with the data source to be updated when their pause of data refresh is disabled. Note: This operation is only supported for data sources associated with charts or tables. For more information about the different modes, see the chapter "Use Pause Refresh Options and APIs" in SAP Analytics Cloud Help.

Parameters

Since

2020.20

Last Update

2021.18 |

Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set the variable value of a variable for a data source of a widget that overrides variables, then this operation sets only the variable value for this widget. If you set an empty variable value to a mandatory variable, then this operation is ignored. If you set a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.

Parameters

Since

2019.22

Last Update

2021.17 |

Type Library datasource

C

<a name="datasourcecomments"></a>

DataSourceComments

Since

2019.18

Last Update

2023.6

Method Summary

Method Detail

Adds a comment to data cells. The data cells are specified by the selection. If this operation was successful, then the comment is returned, and undefined if it wasn't.

Parameters

Returns

CommentInfo

Mobile Support

Not supported on mobile devices. |

Adds multiple comments to data cells. The data cells are specified by the selection. If this operation was successful, then the comments are returned, and undefined if it wasn't. Note: Not supported for SAP BW live data models.

Parameters

Returns

CommentInfo[]

Mobile Support

Not supported on mobile devices.

Since

2020.22 |

Returns all comments of data cells. The data cells are specified by the selection. If no comments exist, then an empty array is returned. Note: For SAP BW live data models, returns the only comment of the latest version.

Parameters

Returns

CommentInfo[]

Mobile Support

Not supported on mobile devices. |

Returns a comment. The comment is specified by the comment ID. If the comment ID is invalid, then undefined is returned.

Parameters

Returns

CommentInfo

Mobile Support

Not supported on mobile devices. |

Removes all comments on data cells. The data cells are specified by the selection. If this operation was successful, then true is returned, and false if it wasn't. Note: For SAP BW live data models, removes the only comment along with all history versions.

Parameters

Returns

boolean

Mobile Support

Not supported on mobile devices. |

Removes a comment. The comment is specified by the comment ID. If this operation was successful, then true is returned, and false if it wasn't.

Parameters

Returns

boolean

Mobile Support

Not supported on mobile devices. |

Switches the Like flag of a comment on or off. The comment is specified by the comment ID. If the comment ID is valid, then true is returned, and false if it isn't. Note: Not supported for SAP BW live data models.

Parameters

Returns

boolean

Mobile Support

Not supported on mobile devices.

Since

2019.21 |

Updates a comment. The comment is specified by the comment ID. Returns the latest comment if this operation is successful, and undefined if it fails. Note: Only supported for SAP BW live data models.

Parameters

Returns

CommentInfo

Mobile Support

Not supported on mobile devices.

Since

2023.6 |

Type Library datasource

C

<a name="datasourceinfo"></a>

DataSourceInfo

Since

2021.19

Property Summary

Property Detail

Type Library planning

E

<a name="datauploadexecutionresponsestatus"></a>

DataUploadExecutionResponseStatus

Since

2024.17

Property Summary

Property Detail

Type Library standard

O

Date

Creates JavaScript Date instances which let you work with dates and times.

Method Summary

Method Detail

Returns the number of milliseconds in a date since January 1, 1970, 00:00:00 UTC.

Parameters

Returns

integer |

Parses a string representation of a date and returns the number of milliseconds since January 1, 1970, 00:00:00 UTC.

Parameters

Returns

integer |

Sets the day of the month of a specified date according to local time (where 1 represents the first day of the month). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the full year of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the hours of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the milliseconds of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the minutes of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the month of a specified date according to local time (where 0 represents the first month of the year). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the seconds of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the date to the time represented by a number of milliseconds since January 1, 1970, 00:00:00 UTC.

Parameters

Returns

integer |

Sets the day of the month of a specified date according to universal time (where 1 represents the first day of the month). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the full year of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the hour of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the milliseconds of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the minutes of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the month of a specified date according to universal time (where 0 represents the first month of the year). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Sets the seconds of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.

Parameters

Returns

integer |

Type Library standard

C

<a name="filedatasource"></a>

FileDataSource

Since

2023.13

Method Summary

Method Detail

Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.

Parameters

Returns

FilterValue[] |

Returns the values of the variable on the story. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function.

Parameters

Returns

VariableValue[] |

Removes any filter that is set on the dimension. Advanced Filters aren't affected.

Parameters

Removes the value of the variable on the story. This removes the variable value of the variable for the data source on the story.

Parameters

Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. The specified members need to be part of the hierarchy.

Parameters

Sets the value of the variable on the story. If you set an empty variable value to a mandatory variable, then this operation is ignored. Note: The variable value will not be validated.

Parameters

Type Library planning

C

<a name="inputcontrol"></a>

InputControl

extends Widget

Since

2021.13

Last Update

2023.7

Method Summary

Event Summary

Method Detail

Event Detail

Type Library visualization-controls

C

<a name="inputcontroldatasource"></a>

InputControlDataSource

Since

2022.14

Last Update

2025.7

Method Summary

Method Detail

Returns the active selected dimension members. You can define how many members are returned at most. By default it's 100 if not specified. Note: Not supported for input controls that display all available members including unbooked ones. Not supported for range filters and advanced filters. Not supported for members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting. Note: Please consider the performance impact when using this API. Always try to use it on input controls with low cardinality dimensions, or turn on cascading effect to narrow down the dimension members on input controls.

Parameters

Returns

MemberInfo[]

Last Update

2025.7 |

Returns the active selected dimension members on the input control, including unbooked ones. To use this API, ensure that the input control is either dimension member or calculation input control, and cascading effect off. Other types such as range filters aren't supported. Members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting aren’t supported. You can limit the number of returned members (by default 100). Be mindful of performance impacts on high cardinality dimensions.

Parameters

Returns

MemberInfo[]

Since

2024.1

Last Update

2025.7 |

Sets dimension members on the input control. The dimension members should be from the selected members configured at design time. Note: Not supported for input controls that display all available members including unbooked ones. Not supported for range filters and advanced filters. Not supported for members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting.

Parameters

Sets dimension members on the input control, including unbooked ones. To use this API, ensure that the input control is either dimension member or calculation input control, and cascading effect off. Other types such as range filters aren't supported. Members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting aren’t supported. The dimension members should be from the selected members configured at design time.

Parameters

Since

2024.1 |

Type Library input-controls

C

<a name="odataerror"></a>

ODataError

Since

2019.7

Property Summary

| |
| --- |
| Name and Description |
| code: string |
| details: ODataError[] |
| message: string |
| target: string |

Property Detail

| |
| --- |
| code |
| code: string |

| |
| --- |
| details |
| details: ODataError[] |

| |
| --- |
| message |
| message: string |

| |
| --- |
| target |
| target: string |

Type Library
oDataService

C
\

<a name="odataqueryoptions"></a>

ODataQueryOptions

Since

2020.7

Property Summary

| |
| --- |
| Name and Description |
| filter: string |
| orderby: string |
| select: string |
| skip: integer |
| top: integer |

Property Detail

| |
| --- |
| filter |
| filter: string |

| |
| --- |
| orderby |
| orderby: string |

| |
| --- |
| select |
| select: string |

| |
| --- |
| skip |
| skip: integer |

| |
| --- |
| top |
| top: integer |

Type Library
containers

C
\

<a name="rdataframe"></a>

RDataFrame

Method Summary

| |
| --- |
| Name and Description |
| getDataSource(): DataSource<br>Returns the data source of the data frame. |

Method Detail

| |
| --- |
| getDataSource |
| getDataSource(): DataSource<br>Returns the data source of the data frame.<br>Returns<br>DataSource |

Type Library
advanced-controls

C
\

DataUploadStarter

Type Library: planning | Since: 2025.17 | Last Update: 2026.7

Widget for initiating data uploads. Extends Widget.

Events:

DataUploadStarter_1.onAfterExecute = function(status, message, statistics, rejectedDetails, versionName, fileName) {
    if (status === DataUploadExecutionResponseStatus.Success) {
        Text_Status.setText("Upload complete: " + statistics.uploadedRowCount + " rows");
    }
    if (rejectedDetails.length > 0) {
        Text_Warning.setText(rejectedDetails.length + " rows rejected");
    }
    Text_File.setText("File: " + fileName);
    Text_Version.setText("Version: " + versionName);
};

DataUploadStarter_1.onBeforeImport = function(fileName, fileContent, versionName, firstRowAsHeaders) {
    return {
        continue: true,
        modifiedFileContent: fileContent
    };
};

Inherited from Widget: getCssClass(), getLayout(), isVisible(), setCssClass(), setVisible().

DataUploadStatistics

Type Library: planning | Since: 2026.7 | Last Update: 2026.8

An object defining the upload statistics of results for the data upload execution.

Properties:

var stats = event.statistics;
console.log("Uploaded: " + stats.uploadedRowCount);
console.log("Rejected: " + stats.rejectedRowCount);
console.log("Deleted: " + stats.deletedRowCount);

DataUploadFileHandler

Type Library: planning | Since: 2026.1

An object defining a return value for the onBeforeImport event handler. Can be passed as a JSON object to method arguments.

Properties:

DataUploadStarter_1.onBeforeImport = function(fileName, fileContent, versionName, firstRowAsHeaders) {
    var modified = fileContent.map(function(row) {
        return row.map(function(cell) {
            return cell.trim();
        });
    });
    return {
        continue: true,
        modifiedFileContent: modified
    };
};