OLAP functions

Note: Most OLAP functions in BI# correspond to the original OLAP functions. Their names and parameters are similar. For a more detailed explanation, see the documentation of the Infor d/EPM OLAP Server Software Development Kit.

ConvertToStringList

Declaration

StringList ConvertToStringList(string x)

Description

Converts a single string into a StringList. The first element of the StringList is an empty string. You can use it in OLAP functions that expect this format.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`x`	`String to be turned into a StringList.`

Return Value

StringList containing only the parameter 'x'.

ConvertToStringList

Declaration

StringList ConvertToStringList(DataAreaDimensionFilter x)

Description

Turns a single DataAreaDimensionFilter into a StringList.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`x`	`DataAreaDimensionFilter to be turned into a StringList.`

Return Value

StringList containing only the parameter 'x'.

ConvertToStringList

Declaration

StringList ConvertToStringList(OLAPElement x)

Description

Converts a single OLAPElement into a StringList. The first element of the StringList is an empty string. You can use it in OLAP functions that expect this format.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`x`	`OLAPElement to be turned into a StringList.`

Return Value

StringList containing only the parameter 'x'.

ConvertToStringList

Declaration

StringList ConvertToStringList(OLAPElementList x)

Description

Converts a single OLAPElementList into a StringList. The first element of the StringList is an empty string. You can use it in OLAP functions that expect this format.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`x`	`OLAPElementList to be turned into a StringList.`

Return Value

StringList containing only the parameter 'x'.

ConvertToStringList

Declaration

StringList ConvertToStringList(StringArray x)

Description

Converts a single StringArray into a StringList. The first element of the StringList is an empty string. You can use it in OLAP functions that expect this format.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`x`	`StringArray to be turned into a StringList.`

Return Value

StringList containing only the parameter 'x'.

CreateOLAPElementList

Declaration

OLAPElementList CreateOLAPElementList()

Description

Creates an empty OLAPElementList that can be changed by BI# runtime functions only.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0

Parameters

The function has no parameters.

Return Value

An empty OLAPElementList.

OLAPAddHierarchyElement

Declaration

int OLAPAddHierarchyElement(OLAPConnection connection, string dimensionName, string hierarchyName, string element, string type, bool throwException)

Description

Adds an element to the root level of an OLAP hierarchy.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`element`	`The name of a new element.`
`type`	`The type of the new element ("N" \| "S").`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPAddHierarchyElements

Declaration

int OLAPAddHierarchyElements(OLAPConnection connection, string dimensionName, string hierarchyName, StringList hierarchyElementsFlatList, StringList hierarchyElementTypesFlatList, bool throwException)

Description

Adds elements to the root level of an OLAP hierarchy.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`hierarchyElementsFlatList`	`The list of elements' names to be added.`
`hierarchyElementTypesFlatList`	`The types of the new elements ("N" \| "S").`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPAddNumericalElement

Declaration

bool OLAPAddNumericalElement(OLAPConnection connection, string elementName, string parentName, double weight)

Description

Adds a new numerical element to the dimension that is being created. You must call OLAPCreateDimensionBegin before calling this function. After the creation of all elements, you must also call OLAPCreateDimensionEnd.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`elementName`	`Name of the element to be created.`
`parentName`	`Name of the element's parent.`
`weight`	`The element's weight.`

Return Value

True, if the element could be added. False, if the element could not be added.

OLAPAddNumericalElement

Declaration

void OLAPAddNumericalElement(OLAPEditDimensionRequest request, string elementName)

Description

Adds a numerical element to an OLAPEditDimensionRequest.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`request`	`The OLAPEditDimensionRequest to add the element to.`
`elementName`	`Name of the element to be added.`

Return Value

Does not return a value.

OLAPAddNumericalElement

Declaration

void OLAPAddNumericalElement(OLAPEditDimensionRequest request, string elementName, string parentElementName, double weight)

Description

Adds a numerical element to an OLAPEditDimensionRequest.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`request`	`The OLAPEditDimensionRequest to add the element to.`
`elementName`	`Name of the element to be added.`
`parentElementName`	`Name of the new element's parent element.`
`weight`	`Weight of the new element.`

Return Value

Does not return a value.

OLAPAddNumericalElement

Declaration

void OLAPAddNumericalElement(OLAPConnection connection, string elementName)

Description

Adds a new numerical element to the dimension that is being created. You must call OLAPCreateDimensionBegin before calling this function. After the creation of all elements, you must also call OLAPCreateDimensionEnd.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`elementName`	`Name of the element to be created.`

Return Value

Does not return a value.

OLAPAddNumericalSubElement

Declaration

bool OLAPAddNumericalSubElement(OLAPConnection connection, string elementName, double weight)

Description

Adds a new numerical element to the dimension that is being created. You must call OLAPCreateSubElementBegin before calling this function. After the creation of all elements, you must also call OLAPCreateSubElementEnd.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`elementName`	`Name of the element to be created.`
`weight`	`The element's weight.`

Return Value

True, if the element could be added. False, if the element could not be added.

OLAPAddParentElement

Declaration

int OLAPAddParentElement(OLAPConnection connection, string dimension, string hierarchy, string element, string newParent, bool throwException)

Description

Adds a new parent-child relationship between two elements. If a parent element of that name already exists, then only the parent-child relation is created. Otherwise, a new element is created and then the relation is created. This function sets the weight of the relation to the default value, which is 1. Moreover, if the element already has a parent element, then a new parent element is added. As a result, the element has two parents and each of the parent-child relations has its own weight.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`element`	`The element that should receive a new parent.`
`newParent`	`The element's new parent.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPAddParentElement

Declaration

int OLAPAddParentElement(OLAPConnection connection, string dimension, string hierarchy, string element, string newParent, double weight, bool throwException)

Description

Adds a new parent-child relationship between two elements. If a parent element of that name already exists, then only the parent-child relation is created. Otherwise, a new element is created and then the relation is created. Moreover, if the element already has a parent element, then a new parent element is added. As a result, the element has two parents and each of the parent-child relations has its own weight. This overload makes it possible to set the weight directly.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`element`	`The element that should receive a new parent.`
`newParent`	`The element's new parent.`
`weight`	`The weight between parent element and child element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPAddParentElement

Declaration

int OLAPAddParentElement(OLAPConnection connection, string dimension, string hierarchy, StringList elements, string newParent, bool throwException)

Description

Adds a new parent-child relationship between a parent and a list of elements. If a parent element of that name already exists, then only the parent-child relation is created. Otherwise, a new element is created and then the relation is created. This function sets the weight of the relation to the default value, which is 1. Moreover, if the element already has a parent element, then a new parent element is added. As a result, the element has two parents and each of the parent-child relations has its own weight. This overload does not allow you to control atomicity. Partial failures are ignored.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`elements`	`The list of child elements.`
`newParent`	`The parent element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPAddParentElement

Declaration

StringListList OLAPAddParentElement(OLAPConnection connection, string dimension, string hierarchy, StringList elements, string newParent, bool throwException, bool breakOnError)

Description

Adds a new parent-child relationship between a parent and a list of elements. If a parent element of that name already exists, then only the parent-child relation is created. Otherwise, a new element is created and then the relation is created. This function sets the weight of the relation to the default value, which is 1. Moreover, if the element already has a parent element, then a new parent element is added. As a result, the element has two parents and each of the parent-child relations has its own weight. This overload makes it possible to control the atomicity of the request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`elements`	`The list of child elements.`
`newParent`	`The parent element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`
`breakOnError`	`Controls the atomicity of the request. If True, partial failure makes the whole request fail. If False, atomicity is suppressed and a list of partial failures is returned.`

Return Value

Instance of StringListList that carries information about partial errors. If no error occurred, the StringListList is empty. In case of any partial errors, it contains the StringList instance for each partial failure. Each StringList contains six strings with this meaning [position in the command buffer, error code, operation type, element1, element2, error message].

OLAPAddParentElement

Declaration

int OLAPAddParentElement(OLAPConnection connection, string dimension, string hierarchy, StringList elements, string newParent, DoubleArray weights, bool throwException)

Description

Adds a new parent-child relationship between a parent and a list of elements. If a parent element of that name already exists, then only the parent-child relation is created. Otherwise, a new element is created and then the relation is created. Moreover, if the element already has a parent element, then a new parent element is added. As a result, the element has two parents and each of the parent-child relations has its own weight. This overload makes it possible to set the weight directly.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`elements`	`The list of child elements.`
`newParent`	`The parent element.`
`weights`	`The weights between the child elements and the parent element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPAddParentElement

Declaration

void OLAPAddParentElement(OLAPEditDimensionRequest request, string element, string newParent)

Description

Adds a parent to an element. If a parent element of that name already exists, then only the parent-child relation is created. Otherwise, a new element is created and then the relation is created. This function sets the weight of the relation to the default value, which is 1. Moreover, if the element already has a parent element, then a new parent element is added. As a result, the element has two parents and each of the parent-child relations has its own weight.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`An OlapEditDimensionRequest to be used.`
`element`	`The element to add the parent to.`
`newParent`	`The parent to be added.`

Return Value

Does not return a value.

OLAPAddParentElement

Declaration

bool OLAPAddParentElement(OLAPConnection connection, string dimension, string element, string newParent)

Description

Adds a parent to an element.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension of the element.`
`element`	`The element to add the parent to.`
`newParent`	`The parent to be added.`

Return Value

True, if the parent has been added. False, if an error has occurred.

OLAPAddSplashCommandElement

Declaration

void OLAPAddSplashCommandElement(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, string dimension, string hierarchy, string element, int distribute)

Description

Add element of a given type to the command. Throws an exception if cubes do not match.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimension`	`Dimension of the element.`
`hierarchy`	`Hierarchy of the element.`
`element`	`Name of the element.`
`distribute`	`The values of the Distribute parameter for the Reference or Driver elements (ignored for other).`

Return Value

Does not return a value.

OLAPAddSplashCommandElement

Declaration

void OLAPAddSplashCommandElement(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, string dimension, string hierarchy, string element)

Description

Add element of a given type to the command. Throws an exception if cubes do not match.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimension`	`Dimension of the element.`
`hierarchy`	`Hierarchy of the element.`
`element`	`Name of the element.`

Return Value

Does not return a value.

OLAPAddSplashCommandElement

Declaration

void OLAPAddSplashCommandElement(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, string dimension, string element, int distribute)

Description

Add element of a given type to the command. Throws an exception if cubes do not match.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimension`	`Dimension of the element.`
`element`	`Name of the element.`
`distribute`	`The values of the Distribute parameter for the Reference or Driver elements (ignored for other).`

Return Value

Does not return a value.

OLAPAddSplashCommandElement

Declaration

void OLAPAddSplashCommandElement(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, string dimension, string element)

Description

Add element of a given type to the command. Throws an exception if cubes do not match.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimension`	`Dimension of the element.`
`element`	`Name of the element.`

Return Value

Does not return a value.

OLAPAddTextualElement

Declaration

void OLAPAddTextualElement(OLAPEditDimensionRequest request, string elementName)

Description

Adds a textual element to an OLAPEditDimensionRequest.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`request`	`The OLAPEditDimensionRequest to add the new element to.`
`elementName`	`The name of the new element.`

Return Value

Does not return a value.

OLAPAddTextualElement

Declaration

void OLAPAddTextualElement(OLAPEditDimensionRequest request, string elementName, string parentElementName)

Description

Adds a textual element to an OLAPEditDimensionRequest.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`request`	`The OLAPEditDimensionRequest to add the new element to.`
`elementName`	`The name of the new element.`
`parentElementName`	`The name of the new element's parent element.`

Return Value

Does not return a value.

OLAPAddTextualElement

Declaration

void OLAPAddTextualElement(OLAPConnection connection, string elementName)

Description

Adds a new textual element to the dimension that is being created. You must call OLAPCreateDimensionBegin before calling this functions. After the creation of all elements, you must also call OLAPCreateDimensionEnd.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`elementName`	`Name of the element to be created.`

Return Value

Does not return a value.

OLAPAddTextualSubElement

Declaration

bool OLAPAddTextualSubElement(OLAPConnection connection, string elementName)

Description

Adds a new textual element to the dimension that is being created. You must call OLAPCreateSubElementBegin before calling this functions. After the creation of all elements, you must also call OLAPCreateSubElementEnd.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`elementName`	`Name of the element to be created.`

Return Value

True, if the element could be added. False, if the element could not be added.

OLAPAttachConnection

Declaration

OLAPConnection OLAPAttachConnection(string database, string sid)

Description

Creates a new OLAP connection using an existing session's ID. This function is deprecated. Use OLAPAttachNamedConnection() instead.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`database`	`Name of the OLAP server to connect to.`
`sid`	`OLAP session ID.`

Return Value

A new OLAP connection.

OLAPAttachNamedConnection

Declaration

OLAPConnection OLAPAttachNamedConnection(string dataConnectionName, string sid)

Description

Creates a new OLAP connection using an existing session's ID.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dataConnectionName`	`Name of the data source.`
`sid`	`OLAP session ID.`

Return Value

A new OLAP connection.

OLAPCellDelete

Declaration

bool OLAPCellDelete(OLAPConnection connection, string cube, string element1, string element2, ... elements[string])

Description

Deletes a cell. The cell note is deleted as well, if it exists.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

True, if the value could be deleted, false otherwise.

OLAPCellDeleteComment

Declaration

bool OLAPCellDeleteComment(OLAPConnection connection, string cube, string element1, string element2, ... elements[string])

Description

Deletes a cell comment of a cube's cell.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to delete from.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

The cell comment read. If no comment is available, the result is an empty string.

OLAPCellDeleteCommentDynamic

Declaration

bool OLAPCellDeleteCommentDynamic(OLAPConnection connection, string cube, StringArray elements)

Description

Deletes a cell comment of a cube's cell.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to delete from.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

The cell comment read. If no comment is available, the result is an empty string.

OLAPCellDeleteDynamic

Declaration

bool OLAPCellDeleteDynamic(OLAPConnection connection, string cube, bool withHierarchies, StringArray elements)

Description

Deletes a cell. The cell note is deleted as well, if it exists.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`withHierarchies`	`Indicates if composite names are used. If true, behaves like normal OLAPCellDeleteDynamic. If the parameter value is not consistent with the format of the element names, the value of the parameter is adjusted or the element names are converted.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be deleted, false otherwise.

OLAPCellDeleteDynamic

Declaration

bool OLAPCellDeleteDynamic(OLAPConnection connection, string cube, StringArray elements)

Description

Deletes a cell. The cell note is deleted as well, if it exists.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be deleted, false otherwise.

OLAPCellGetElement

Declaration

string OLAPCellGetElement(OLAPCell cell, string dimension)

Description

Gets the element used in the cell for a specific dimension.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`The cell to get the element from.`
`dimension`	`Name of the dimension.`

Return Value

The element for the specified dimension. If a cell is defined by composite names (for example, a cell comes from data area which was defined with hierarchies), a composite name is returned. If a cell is defined by simple names, a simple name is returned.

OLAPCellGetElement

Declaration

string OLAPCellGetElement(OLAPCell cell, int dimension)

Description

Gets the element used in the cell for a specific dimension.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`The cell to get the element from.`
`dimension`	`The index of the dimension.`

Return Value

The element for the specified dimension. If a cell is defined by composite names (for example, a cell comes from data area that was defined with hierarchies), a composite name is returned. If a cell is defined by simple names, a simple name is returned.

OLAPCellGetElements

Declaration

StringArray OLAPCellGetElements(OLAPCell cell)

Description

Returns all elements referencing a cell.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`Cell to return elements for.`

Return Value

All elements referencing the cell. If a cell is defined by composite names (for example, a cell comes from data area that was defined with hierarchies), a composite name is returned. If a cell is defined by simple names, a simple name is returned.

OLAPCellIncrementNumber

Declaration

bool OLAPCellIncrementNumber(OLAPConnection connection, string cube, double value, string element1, string element2, ... elements[string])

Description

Increments a numeric value in a cube.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`value`	`The value to be incremented.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellIncrementNumberDynamic

Declaration

bool OLAPCellIncrementNumberDynamic(OLAPConnection connection, string cube, double value, StringArray elements)

Description

Increments a numeric value in a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`value`	`The value to be incremented.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellIsBaseCell

Declaration

bool OLAPCellIsBaseCell(OLAPCell cell)

Description

Checks whether a certain OLAPCell represents a base cell.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a base cell, false otherwise.

OLAPCellIsBaseElement

Declaration

bool OLAPCellIsBaseElement(OLAPCell cell)

Description

Checks whether a certain OLAPCell represents a base element.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a base element, false otherwise.

OLAPCellIsConsolidatedCell

Declaration

bool OLAPCellIsConsolidatedCell(OLAPCell cell)

Description

Checks whether a certain OLAPCell represents a consolidated cell.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a consolidated cell, false otherwise.

OLAPCellIsConsolidationElement

Declaration

bool OLAPCellIsConsolidationElement(OLAPCell cell)

Description

Checks whether a certain OLAPCell represents a consolidation element.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a consolidation element, false otherwise.

OLAPCellIsNull

Declaration

bool OLAPCellIsNull(OLAPConnection connection, string cube, string element1, string element2, ... elements[string])

Description

Checks whether a cell value is null (#NA).

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

The value that is read.

OLAPCellIsNullDynamic

Declaration

bool OLAPCellIsNullDynamic(OLAPConnection connection, string cube, StringArray elements)

Description

Checks whether a cell value is null (#NA).

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

The value that is read.

OLAPCellIsRuleCell

Declaration

bool OLAPCellIsRuleCell(OLAPCell cell)

Description

Checks whether a certain OLAPCell is a rule cell.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a rule cell, false otherwise.

OLAPCellIsRuleElement

Declaration

bool OLAPCellIsRuleElement(OLAPCell cell)

Description

Checks whether a certain OLAPCell represents a rule element.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a rule element, false otherwise.

OLAPCellIsTextCell

Declaration

bool OLAPCellIsTextCell(OLAPCell cell)

Description

Checks whether a certain OLAPCell represents a text element.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`OLAPCell to be checked.`

Return Value

True, if the OLAPCell represents a text element, false otherwise.

OLAPCellReadComment

Declaration

string OLAPCellReadComment(OLAPConnection connection, string cube, string element1, string element2, ... elements[string])

Description

Reads a cell comment from a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

The cell comment read. If no comment is available, the result is an empty string.

OLAPCellReadCommentDynamic

Declaration

string OLAPCellReadCommentDynamic(OLAPConnection connection, string cube, StringArray elements)

Description

Reads a cell comment from a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

The cell comment read. If no comment is available, the result is an empty string.

OLAPCellReadNumber

Declaration

double OLAPCellReadNumber(OLAPConnection connection, string cube, double factor, string element1, string element2, ... elements[string])

Description

Reads a numeric cell from a cube.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`factor`	`A factor to scale the read value.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

The value that is read.

OLAPCellReadNumberDynamic

Declaration

double OLAPCellReadNumberDynamic(OLAPConnection connection, string cube, double factor, StringArray elements)

Description

Reads a numeric cell from a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`factor`	`A factor to scale the read value.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

The value that is read.

OLAPCellReadString

Declaration

string OLAPCellReadString(OLAPConnection connection, string cube, string element1, string element2, ... elements[string])

Description

Reads a text cell from a cube.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

The value that is read.

OLAPCellReadStringDynamic

Declaration

string OLAPCellReadStringDynamic(OLAPConnection connection, string cube, StringArray elements)

Description

Reads a text cell from a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

The value that is read.

OLAPCellWriteBufferDeleteCell

Declaration

void OLAPCellWriteBufferDeleteCell(OLAPCellWriteBuffer buffer, string cubeName, string element1, string element2, ... elements[string])

Description

Adds a command for deleting a cell to an OLAPCellWriteBuffer. The cell note of the cell is deleted as well, if it exists.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferDeleteCellDynamic

Declaration

void OLAPCellWriteBufferDeleteCellDynamic(OLAPCellWriteBuffer buffer, string cubeName, StringArray elements)

Description

Adds a command for deleting a cell to an OLAPCellWriteBuffer. The cell note of the cell is deleted as well, if it exists.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferDeleteComment

Declaration

void OLAPCellWriteBufferDeleteComment(OLAPCellWriteBuffer buffer, string cubeName, string element1, string element2, ... elements[string])

Description

Adds a command for deleting a cell's comment to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferDeleteCommentDynamic

Declaration

void OLAPCellWriteBufferDeleteCommentDynamic(OLAPCellWriteBuffer buffer, string cubeName, StringArray elements)

Description

Adds a command for deleting a cell's comment to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferDeleteValue

Declaration

void OLAPCellWriteBufferDeleteValue(OLAPCellWriteBuffer buffer, string cubeName, string element1, string element2, ... elements[string])

Description

Adds a command for deleting a cell's value to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferDeleteValueDynamic

Declaration

void OLAPCellWriteBufferDeleteValueDynamic(OLAPCellWriteBuffer buffer, string cubeName, StringArray elements)

Description

Adds a command for deleting a cell's value to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferIncrementNumber

Declaration

void OLAPCellWriteBufferIncrementNumber(OLAPCellWriteBuffer buffer, string cubeName, double value, string element1, string element2, ... elements[string])

Description

Adds a command for incrementing a numeric cell to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell to be incremented.`
`value`	`The value to be added to the cell's current value.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferIncrementNumberDynamic

Declaration

void OLAPCellWriteBufferIncrementNumberDynamic(OLAPCellWriteBuffer buffer, string cubeName, double value, StringArray elements)

Description

Adds a command for incrementing a numeric cell to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`value`	`The value to be written.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferSetComment

Declaration

void OLAPCellWriteBufferSetComment(OLAPCellWriteBuffer buffer, string cubeName, string comment, string element1, string element2, ... elements[string])

Description

Adds a command for setting a cell's comment to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`comment`	`The comment to be set.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferSetCommentDynamic

Declaration

void OLAPCellWriteBufferSetCommentDynamic(OLAPCellWriteBuffer buffer, string cubeName, string comment, StringArray elements)

Description

Adds a command for setting a cell's comment to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`comment`	`The comment to be set.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferWriteNumber

Declaration

void OLAPCellWriteBufferWriteNumber(OLAPCellWriteBuffer buffer, string cubeName, double value, string element1, string element2, ... elements[string])

Description

Adds a command for setting a numeric cell's value to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`value`	`The value to be written.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferWriteNumberDynamic

Declaration

void OLAPCellWriteBufferWriteNumberDynamic(OLAPCellWriteBuffer buffer, string cubeName, double value, StringArray elements)

Description

Adds a command for setting a numeric cell's value to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`value`	`The value to be written.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferWriteString

Declaration

void OLAPCellWriteBufferWriteString(OLAPCellWriteBuffer buffer, string cubeName, string value, string element1, string element2, ... elements[string])

Description

Adds a command for setting a text cell's value to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`value`	`The value to be written.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

Does not return a value.

OLAPCellWriteBufferWriteStringDynamic

Declaration

void OLAPCellWriteBufferWriteStringDynamic(OLAPCellWriteBuffer buffer, string cubeName, string value, StringArray elements)

Description

Adds a command for setting a text cell's value to an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to add the command to.`
`cubeName`	`The cube containing the cell.`
`value`	`The value to be written.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

Does not return a value.

OLAPCellWriteComment

Declaration

bool OLAPCellWriteComment(OLAPConnection connection, string cube, string comment, string element1, string element2, ... elements[string])

Description

Writes a cell comment to a cell of a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to write to.`
`comment`	`The comment to write.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

The cell comment read. If no comment is available, the result is an empty string.

OLAPCellWriteCommentDynamic

Declaration

bool OLAPCellWriteCommentDynamic(OLAPConnection connection, string cube, string comment, StringArray elements)

Description

Writes a cell comment to a cell of a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to write to.`
`comment`	`The comment to write.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

The cell comment read. If no comment is available, the result is an empty string.

OLAPCellWriteNumber

Declaration

bool OLAPCellWriteNumber(OLAPConnection connection, string cube, double value, string element1, string element2, ... elements[string])

Description

Writes a numeric value to a cube.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`value`	`The value to write.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellWriteNumberDynamic

Declaration

bool OLAPCellWriteNumberDynamic(OLAPConnection connection, string cube, bool withHierarchies, double value, StringArray elements)

Description

Writes a numeric value to a cube.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`withHierarchies`	`Indicates, if alternate hierarchies are used. If the parameter value is not consistent with the format of the element names, the value of the parameter is adjusted or the element names are converted.`
`value`	`The value to write.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellWriteNumberDynamic

Declaration

bool OLAPCellWriteNumberDynamic(OLAPConnection connection, string cube, double value, StringArray elements)

Description

Writes a numeric value to a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`value`	`The value to write.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellWriteString

Declaration

bool OLAPCellWriteString(OLAPConnection connection, string cube, string value, string element1, string element2, ... elements[string])

Description

Writes a text value to a cube.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`value`	`The value to write.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellWriteStringDynamic

Declaration

bool OLAPCellWriteStringDynamic(OLAPConnection connection, string cube, bool withHierarchies, string value, StringArray elements)

Description

Writes a text value to a cube.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`withHierarchies`	`Indicates, if alternate hierarchies are used. If the parameter value is not consistent with the format of the element names, the value of the parameter is adjusted or the element names are converted.`
`value`	`The value to write.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPCellWriteStringDynamic

Declaration

bool OLAPCellWriteStringDynamic(OLAPConnection connection, string cube, string value, StringArray elements)

Description

Writes a text value to a cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`value`	`The value to write.`
`elements`	`An array of dimension element names depending on the cube. One element must be provided for each dimension in the cube.`

Return Value

True, if the value could be written, false otherwise.

OLAPChangeElementWeight

Declaration

bool OLAPChangeElementWeight(OLAPConnection connection, string dimension, string element, string parentElement, double weight)

Description

Change weight of an element

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension that must contain the element and the parent element.`
`element`	`The element to get the weight for. It supports both simple and composite names.`
`parentElement`	`The parent to get the weight for. It supports both simple and composite names.`
`weight`	`The new value of the weight.`

Return Value

True, if the parent element has been replaced, false if an error occurred.

OLAPChangeParentElement

Declaration

void OLAPChangeParentElement(OLAPEditDimensionRequest request, string element, string oldParent, string newParent)

Description

Changes an element's parent.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`The OLAPEditDimensionRequest to be used.`
`element`	`The element to change the parent of.`
`oldParent`	`The element's old parent.`
`newParent`	`The element's new parent.`

Return Value

Does not return a value.

OLAPChangeParentElement

Declaration

bool OLAPChangeParentElement(OLAPConnection connection, string dimension, string element, string oldParent, string newParent)

Description

Changes an element's parent.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension of the element.`
`element`	`The element to change the parent of. It supports both simple and composite names.`
`oldParent`	`The element's old parent. It supports both simple and composite names.`
`newParent`	`The element's new parent. It supports both simple and composite names.`

Return Value

True, if the element's parent has been changed. False, if an error has occurred.

OLAPClearBoolAttributeReadCache

Declaration

void OLAPClearBoolAttributeReadCache(OLAPConnection connection)

Description

Clears the cache used for caching bool attributes.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearCellCommentCache

Declaration

void OLAPClearCellCommentCache(OLAPConnection connection)

Description

Clears the cache used for caching cell comments.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearCellWriteBuffer

Declaration

void OLAPClearCellWriteBuffer(OLAPCellWriteBuffer buffer)

Description

Clears an OLAPCellWriteBuffer and discards all commands.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to be cleared.`

Return Value

Does not return a value.

OLAPClearDateTimeAttributeReadCache

Declaration

void OLAPClearDateTimeAttributeReadCache(OLAPConnection connection)

Description

Clears the cache used for caching DateTime attributes.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearDoubleAttributeReadCache

Declaration

void OLAPClearDoubleAttributeReadCache(OLAPConnection connection)

Description

Clears the cache used for caching double attributes.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearElementCache

Declaration

void OLAPClearElementCache(OLAPConnection connection)

Description

Clears the cache for dimension elements.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearIntAttributeReadCache

Declaration

void OLAPClearIntAttributeReadCache(OLAPConnection connection)

Description

Clears the cache used for caching int attributes.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearNumericalDataReadCache

Declaration

void OLAPClearNumericalDataReadCache(OLAPConnection connection)

Description

Clears the cache used for caching numerical values read from cube cells.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearStringAttributeReadCache

Declaration

void OLAPClearStringAttributeReadCache(OLAPConnection connection)

Description

Clears the cache used for caching string attributes.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPClearStringDataReadCache

Declaration

void OLAPClearStringDataReadCache(OLAPConnection connection)

Description

Clears the cache used for caching string values read from cube cells.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPCommitAttributeTable

Declaration

void OLAPCommitAttributeTable(OLAPConnection connection, OLAPAttributeTable attributeTable)

Description

Stores an OLAPAttributeTable.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`attributeTable`	`The attribute table to be stored.`

Return Value

Does not return a value.

OLAPCommitCellWriteBuffer

Declaration

void OLAPCommitCellWriteBuffer(OLAPCellWriteBuffer buffer)

Description

Commits an OLAPCellWriteBuffer and transfers all commands to the OLAP server.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The buffer to be committed.`

Return Value

Does not return a value.

OLAPConnectionPoolIsEmpty

Declaration

bool OLAPConnectionPoolIsEmpty()

Description

Gets whether the OLAP connection pool is empty.

Supported Runtime Versions

5.0

Parameters

The function has no parameters.

Return Value

True, if the pool is empty.

OLAPCopyDataArea

Declaration

void OLAPCopyDataArea(OLAPDataArea dataArea, string targetCube, string type, double factor, StringListList targetElements, StringListList sourceElements, bool nonExistentCellSupression, bool useOnlyBasicElements)

Description

Creates a copy of the data in a data area.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dataArea`	`The data area to copy.`
`targetCube`	`The name of the target cube.`
`type`	`The operation to be performed with the factor. Values: Relative or Absolute`
`factor`	`The factor to be used during the copy.`
`targetElements`	`The names of the target elements.`
`sourceElements`	`The names of the source elements.`
`nonExistentCellSupression`	`If set to true, source cells with null value are not copied to the target cube.`
`useOnlyBasicElements`	`If set to true, only basic elements are used. If set to false, all base and consolidated elements are used.`

Return Value

Does not return a value.

OLAPCopyDataArea

Declaration

void OLAPCopyDataArea(OLAPDataArea dataArea, string targetCube, string type, double factor, StringList targetDimensions, StringListList targetElements, StringList sourceDimensions, StringListList sourceElements, bool nonExistentCellSupression, bool useOnlyBasicElements)

Description

Creates a copy of the data in a data area.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dataArea`	`The data area to copy.`
`targetCube`	`The name of the target cube.`
`type`	`The operation to be performed with the factor. Values: Relative or Absolute`
`factor`	`The factor to be used during the copy.`
`targetDimensions`	`The list of target dimensions.`
`targetElements`	`The names of the target elements. The order of inner StringLists should correspond to the order of dimensions in targetDimensions.`
`sourceDimensions`	`The list of source dimensions.`
`sourceElements`	`The names of the source elements. The order of inner StringLists should correspond to the order of dimensions in sourceDimensions.`
`nonExistentCellSupression`	`If set to true, source cells with null value are not copied to the target cube.`
`useOnlyBasicElements`	`If set to true, only basic elements are used. If set to false, all base and consolidated elements are used.`

Return Value

Does not return a value.

OLAPCreateAttributeTable

Declaration

OLAPAttributeTable OLAPCreateAttributeTable(string dimension, int attributeTableIndex)

Description

Creates a new and empty OLAPCreateAttributeTable.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`dimension`	`Name of the dimension the attribute table belongs to.`
`attributeTableIndex`	`Index of the attribute table to be created.`

Return Value

A new OLAPAttributeTable object.

OLAPCreateAttributeTable

Declaration

void OLAPCreateAttributeTable(OLAPConnection connection, string dimension, int tableIndex)

Description

Creates an attribute table for a certain dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension to create an attribute table for.`
`tableIndex`	`Index of the attribute table to be created.`

Return Value

Does not return a value.

OLAPCreateAttributeTableFields

Declaration

void OLAPCreateAttributeTableFields(OLAPConnection connection, string dimension, int tableIndex, StringList names, StringList types, StringList descriptions)

Description

Creates dimension attribute fields.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension to create an attribute table for.`
`tableIndex`	`Index of the attribute table to be created.`
`names`	`A list of attributes' names.`
`types`	`A list of attributes' types.`
`descriptions`	`A list of attributes' descriptions.`

Return Value

Does not return a value.

OLAPCreateBooleanAttributeTableField

Declaration

void OLAPCreateBooleanAttributeTableField(OLAPAttributeTable attributeTable, string attributeName, string attributeDescription)

Description

Creates a boolean attribute table field for a certain attribute table.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`attributeTable`	`The attribute table to add the field to.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateBooleanAttributeTableField

Declaration

void OLAPCreateBooleanAttributeTableField(OLAPConnection connection, string dimension, int tableIndex, string attributeName, string attributeDescription)

Description

Not supported anymore, throws an exception. Creates a boolean attribute table field for a certain attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension to create attribute table field for.`
`tableIndex`	`Index of the attribute table to create field for.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateCellWriteBuffer

Declaration

OLAPCellWriteBuffer OLAPCreateCellWriteBuffer(OLAPConnection connection, bool withHierarchies, bool autoCommit)

Description

Creates a new OLAPCellWriteBuffer object.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`The OLAP connection the OLAPCellWriteBuffer works on.`
`withHierarchies`	`If true, the buffer supports alternate hierarchies. In this case, use OLAPCreateCompositeName() function to specify elements.`
`autoCommit`	`If true, all values will be committed automatically when the buffer contains more than 1,000 entries.`

Return Value

A new OLAPCellWriteBuffer object.

OLAPCreateCellWriteBuffer

Declaration

OLAPCellWriteBuffer OLAPCreateCellWriteBuffer(OLAPConnection connection, bool withHierarchies, bool autoCommit, int maxUncommittedValues)

Description

Creates a new OLAPCellWriteBuffer object.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`The OLAP connection the OLAPCellWriteBuffer works on.`
`withHierarchies`	`If true, the buffer supports alternate hierarchies. In this case use OLAPCreateCompositeName() function to specify elements.`
`autoCommit`	`If true, all values will be committed automatically when the buffer contains more than 'maxUncommittedValues' entries.`
`maxUncommittedValues`	`The number of values that lead to the invocation of an auto-commit operation.`

Return Value

A new OLAPCellWriteBuffer object.

OLAPCreateCellWriteBuffer

Declaration

OLAPCellWriteBuffer OLAPCreateCellWriteBuffer(OLAPConnection connection)

Description

Creates a new OLAPCellWriteBuffer object. Commands will be committed automatically when the buffer contains more than 1,000 entries.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The OLAP connection the OLAPCellWriteBuffer works on.`

Return Value

A new OLAPCellWriteBuffer object.

OLAPCreateCellWriteBuffer

Declaration

OLAPCellWriteBuffer OLAPCreateCellWriteBuffer(OLAPConnection connection, bool autoCommit)

Description

Creates a new OLAPCellWriteBuffer object.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The OLAP connection the OLAPCellWriteBuffer works on.`
`autoCommit`	`If true, all values will be committed automatically when the buffer contains more than 1,000 entries.`

Return Value

A new OLAPCellWriteBuffer object.

OLAPCreateCellWriteBuffer

Declaration

OLAPCellWriteBuffer OLAPCreateCellWriteBuffer(OLAPConnection connection, bool autoCommit, int maxUncommittedValues)

Description

Creates a new OLAPCellWriteBuffer object.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The OLAP connection the OLAPCellWriteBuffer works on.`
`autoCommit`	`If true, all values will be committed automatically when the buffer contains more than 'maxUncommittedValues' entries.`
`maxUncommittedValues`	`The number of values that lead to the invocation of an auto-commit operation.`

Return Value

A new OLAPCellWriteBuffer object.

OLAPCreateCellWriteBufferWithHierarchies

Declaration

OLAPCellWriteBuffer OLAPCreateCellWriteBufferWithHierarchies(OLAPConnection connection)

Description

Creates a new OLAPCellWriteBuffer object. Commands will be committed automatically when the buffer contains more than 1,000 entries.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`The OLAP connection the OLAPCellWriteBuffer works on.`

Return Value

A new OLAPCellWriteBuffer object.

OLAPCreateCompositeDataAreaFilter

Declaration

DataAreaDimensionFilter OLAPCreateCompositeDataAreaFilter(string hierarchy, DataAreaDimensionFilter filter)

Description

Creates a data area filter with a hierarchy.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`hierarchy`	`Name of the hierarchy.`
`filter`	`Instance of DataAreaDimensionFilter.`

Return Value

A new data area filter with a hierarchy.

OLAPCreateCompositeName

Declaration

string OLAPCreateCompositeName(string hierarchy, string element)

Description

Creates a composite element name.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`hierarchy`	`Name of the hierarchy.`
`element`	`Name of the element.`

Return Value

A composite name of an element.

OLAPCreateCompositeName

Declaration

string OLAPCreateCompositeName(OLAPElement element)

Description

Creates a composite element name.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`element`	`Instance of OlapElement`

Return Value

A composite name of an element.

OLAPCreateConnection

Declaration

OLAPConnection OLAPCreateConnection(string database, string user, string password)

Description

Creates a new OLAP connection. This function is deprecated. Use OLAPCreateNamedConnection() instead.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`database`	`The server to connect to, in the format server name/database name.`
`user`	`The user to connect with.`
`password`	`The user's password.`

Return Value

A new connection object.

OLAPCreateConnection

Declaration

OLAPConnection OLAPCreateConnection(string database, string ticket)

Description

Creates a new OLAP connection. This function is deprecated. Use OLAPCreateNamedConnection() instead.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`database`	`The server to connect to, in the format server name/database name.`
`ticket`	`The ticket to connect.`

Return Value

A new connection object.

OLAPCreateConnection

Declaration

OLAPConnection OLAPCreateConnection(string connectionString)

Description

Returns a pooled OLAP connection from the OLAP connection pool using a database connection string. The connection string supports these properties: database, user, password, and ticket. You must separate the properties using semicolons. The database property is required. In addition, you must either provide a user and password or ticket. This function is deprecated. Use OLAPCreateNamedConnection() instead.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connectionString`	`The database connection string.`

Return Value

A new OLAP connection.

OLAPCreateCubeAccessControlCube

Declaration

void OLAPCreateCubeAccessControlCube(OLAPConnection connection, string cubeName, string cubeDescription, string dimension1, string dimension2, ... dimensions[string])

Description

Creates a new OLAP access control cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`Name of the cube to be created.`
`cubeDescription`	`The cube's description.`
`dimension1`	`The cube's first dimension.`
`dimension2`	`The cube's second dimension.`
`dimensions`	`The cube's dimensions.`

Return Value

Does not return a value.

OLAPCreateCubeCache

Declaration

OLAPCubeCache OLAPCreateCubeCache(OLAPConnection connection, string cubeName, ... elements[StringList])

Description

Creates a new OlapCubeCache for a certain cube and a certain set of dimensions.

Supported Runtime Versions

1.0


`Parameters`	`Description`
`connection`	`OlapConnection to be used for accessing the OLAP server.`
`cubeName`	`Name of the cube to cache content for.`
`elements`	`Name of all dimensions to cache content for.`

Return Value

A new OlapCubeCache instance.

OLAPCreateCubeCache

Declaration

OLAPCubeCache OLAPCreateCubeCache(OLAPConnection connection, string cubeName, int flags, int firstfilter, double firstvalue, int secondfilter, double secondvalue, ... elements[StringList])

Description

Creates a new OlapCubeCache for a certain cube and a certain set of dimensions. Therefore, the constructor creates a new data area internally.

Supported Runtime Versions

1.0


`Parameters`	`Description`
`connection`	`OlapConnection to be used for accessing the OLAP server.`
`cubeName`	`Name of the cube to cache content for.`
`flags`	`The flags for the data area.`
`firstfilter`	`The first filter type.`
`firstvalue`	`The first filter value.`
`secondfilter`	`The second filter type.`
`secondvalue`	`The second filter value.`
`elements`	`Name of all dimensions to cache content for.`

Return Value

A new OlapCubeCache instance.

OLAPCreateCubeCache

Declaration

OLAPCubeCache OLAPCreateCubeCache(OLAPConnection connection, string cubeName, int flags, DataAreaOperator firstfilter, double firstvalue, DataAreaOperator secondfilter, double secondvalue, StringList element1, StringList element2, ... elements[StringList])

Description

Creates a new OlapCubeCache for a certain cube and a data area definition that specifies, which parts of a cube should be considered in the cache. The cache is filled with the function OLAPFillCubeCache.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`OlapConnection to be used for accessing the OLAP server.`
`cubeName`	`Name of the cube to cache content for.`
`flags`	`The flags for the data area.`
`firstfilter`	`The first filter type.`
`firstvalue`	`The first filter value.`
`secondfilter`	`The second filter type.`
`secondvalue`	`The second filter value.`
`element1`	`Name of the first dimension to cache content for.`
`element2`	`Name of the second dimension to cache content for.`
`elements`	`Names of all remaining dimensions to cache content for.`

Return Value

A new OlapCubeCache instance.

OLAPCreateDataArea

Declaration

OLAPDataArea OLAPCreateDataArea(OLAPConnection connection, string cube, int flags, DataAreaOperator firstfilter, double firstvalue, DataAreaOperator secondfilter, double secondvalue, ... elements[StringList])

Description

Creates a new data area definition. This function supports both simple names and composite names. If a format of element names does not correspond with the value of withHierarchies flag, the element names are converted to composite names and the value of the flag is adjusted. If you want to create a composite element name, use OLAPCreateCompositeName() function. If you want to create a data area filter with hierarchy, use OLAPCreateCompositeDataAreaFilter() function.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`flags`	`The flags for the data area.`
`firstfilter`	`The first filter type.`
`firstvalue`	`The first filter value.`
`secondfilter`	`The second filter type.`
`secondvalue`	`The second filter value.`
`elements`	`The elements for dimensions to filter data. Not required to be specified for all dimensions (OlapDataAreaAllCells filter is used for unspecified ones).`

Return Value

A new data area definition.

OLAPCreateDataArea

Declaration

OLAPDataArea OLAPCreateDataArea(OLAPConnection connection, string cube, int flags, DataAreaOperator firstfilter, double firstvalue, DataAreaOperator secondfilter, double secondvalue, StringListList elements)

Description

Creates a new data area definition. This function supports both simple names and composite names. If a format of element names does not correspond with the value of withHierarchies flag, the element names are converted to composite names and the value of the flag is adjusted. If you want to create a composite element name, use OLAPCreateCompositeName() function. If you want to create a data area filter with hierarchy, use OLAPCreateCompositeDataAreaFilter() function.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to read from.`
`flags`	`The flags for the data area.`
`firstfilter`	`The first filter type.`
`firstvalue`	`The first filter value.`
`secondfilter`	`The second filter type.`
`secondvalue`	`The second filter value.`
`elements`	`The elements for dimensions to filter data. Not required to be specified for all dimensions (OlapDataAreaAllCells filter is used for unspecified ones).`

Return Value

A new data area definition.

OLAPCreateDateAttributeTableField

Declaration

void OLAPCreateDateAttributeTableField(OLAPAttributeTable attributeTable, string attributeName, string attributeDescription)

Description

Creates a date attribute table field for a certain attribute table.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`attributeTable`	`The attribute table to add the field to.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateDateAttributeTableField

Declaration

void OLAPCreateDateAttributeTableField(OLAPConnection connection, string dimension, int tableIndex, string attributeName, string attributeDescription)

Description

Not supported anymore, throws an exception. Creates a date attribute table field for a certain attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension to create attribute table field for.`
`tableIndex`	`Index of the attribute table to create field for.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateDimension

Declaration

void OLAPCreateDimension(OLAPConnection connection, string dimensionName, string dimensionDescription)

Description

Creates a dimension. Automatically creates a numerical element named "-".

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to be created.`
`dimensionDescription`	`The dimension's description.`

Return Value

Does not return a value.

OLAPCreateDimensionAccessControlCube

Declaration

void OLAPCreateDimensionAccessControlCube(OLAPConnection connection, string cubeName, string cubeDescription, string dimension1, string dimension2, ... dimensions[string])

Description

Creates a new OLAP dimension access control cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`Name of the cube to be created.`
`cubeDescription`	`The cube's description.`
`dimension1`	`The cube's first dimension.`
`dimension2`	`The cube's second dimension.`
`dimensions`	`The cube's dimensions.`

Return Value

Does not return a value.

OLAPCreateDimensionBegin

Declaration

void OLAPCreateDimensionBegin(OLAPConnection connection, string dimensionName, string dimensionDescription, string hierarchy)

Description

Starts the creation of a new dimension. If the dimension exists, it is overwritten.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to be created.`
`dimensionDescription`	`The dimension's description.`
`hierarchy`	`The hierarchy name.`

Return Value

Does not return a value.

OLAPCreateDimensionBegin

Declaration

void OLAPCreateDimensionBegin(OLAPConnection connection, string dimensionName, string dimensionDescription)

Description

Starts the creation of a new dimension. If the dimension exists, it is overwritten.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to be created.`
`dimensionDescription`	`The dimension's description.`

Return Value

Does not return a value.

OLAPCreateDimensionEnd

Declaration

StringListList OLAPCreateDimensionEnd(OLAPConnection connection, bool breakOnError)

Description

Finishes the creation of a new dimension. This overload makes it possible to control atomicity of the request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`breakOnError`	`Controls the atomicity of the request. If True, partial failure makes the whole request fail. If False, atomicity is suppressed and a list of partial failures is returned.`

Return Value

Instance of StringListList that carries information about partial errors. If no error occurred, the StringListList is empty. In case of any partial errors, it contains the StringList instance for each partial failure. Each StringList contains six strings with this meaning [position in the command buffer, error code, operation type, element1, element2, error message].

OLAPCreateDimensionEnd

Declaration

void OLAPCreateDimensionEnd(OLAPConnection connection)

Description

Finishes the creation of a new dimension. This overload does not allow you to control atomicity. Partial failures are ignored.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPCreateEditDimensionRequest

Declaration

OLAPEditDimensionRequest OLAPCreateEditDimensionRequest(string dimensionName)

Description

Creates a new OLAPEditDimensionRequest instance. The request can be send to OLAP by calling the OLAPSendRequest function. If the dimension does not exist, then calling of OLAPSendRequest function will fail.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`dimensionName`	`Name of the dimension to be edited.`

Return Value

A new OLAPEditDimensionRequest instance.

OLAPCreateEditDimensionRequest

Declaration

OLAPEditDimensionRequest OLAPCreateEditDimensionRequest(string dimensionName, string hierarchyName)

Description

Creates a new OLAPEditDimensionRequest instance. The request can be send to OLAP by calling the OLAPSendRequest function. If the specified dimension does not exist, then calling of OLAPSendRequest function will fail. If the specified hierarchy exists, it will be edited. If the hierarchy does not exist, it will be created. If the hierarchy does not exist and the request contains an operation that requires the existing hierarchy (for example, removing parent-child relation between elements), the request will fail.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dimensionName`	`Name of the dimension to be edited.`
`hierarchyName`	`Name of the hierarchy to be edited.`

Return Value

A new OLAPEditDimensionRequest instance.

OLAPCreateHierarchy

Declaration

int OLAPCreateHierarchy(OLAPConnection connection, string dimensionName, string hierarchyName, StringList hierarchyElementsFlatList, StringList hierarchyElementTypesFlatList, bool throwException)

Description

Creates a new hierarchy in a dimension.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`hierarchyElementsFlatList`	`A list of elements to be added to a new hierarchy.`
`hierarchyElementTypesFlatList`	`A list of the new elements' types ("N" \| "S").`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPCreateHierarchy

Declaration

int OLAPCreateHierarchy(OLAPConnection connection, string dimensionName, string hierarchyName, string hierarchyElement, string hierarchyElementType, bool throwException)

Description

Creates a new hierarchy in a dimension.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`hierarchyElement`	`The name of an element to be added to a new dimension.`
`hierarchyElementType`	`The type of an element to be added to a new dimension.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPCreateNamedConnection

Declaration

OLAPConnection OLAPCreateNamedConnection(string dataConnectionName)

Description

Creates a new OLAP connection using a data connection.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dataConnectionName`	`Name of the data connection.`

Return Value

A new OLAP connection.

OLAPCreateNumericalAttributeTableField

Declaration

void OLAPCreateNumericalAttributeTableField(OLAPAttributeTable attributeTable, string attributeName, string attributeDescription, int attributeLength, int attributePrecision)

Description

Creates a numerical attribute table field for a certain attribute table.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`attributeTable`	`The attribute table to add the field to.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`
`attributeLength`	`Maximum length of the attribute to be created`
`attributePrecision`	`Precision of the attribute to be created`

Return Value

Does not return a value.

OLAPCreateNumericalAttributeTableField

Declaration

void OLAPCreateNumericalAttributeTableField(OLAPConnection connection, string dimension, int tableIndex, string attributeName, string attributeDescription)

Description

Not supported anymore, throws an exception. Creates a numerical attribute table field for a certain attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension to create attribute table field for.`
`tableIndex`	`Index of the attribute table to create field for.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateNumericalAttributeTableField

Declaration

void OLAPCreateNumericalAttributeTableField(OLAPConnection connection, string dimension, int tableIndex, string attributeName, string attributeDescription, int attributeLength, int attributePrecision)

Description

Not supported anymore, throws an exception. Creates a numerical attribute table field for a certain attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension to create attribute table field for.`
`tableIndex`	`Index of the attribute table to create field for.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`
`attributeLength`	`The maximum length of the attribute to be created.`
`attributePrecision`	`The precision of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateNumericalDimensionElement

Declaration

bool OLAPCreateNumericalDimensionElement(OLAPConnection connection, string dimension, string element, string parentElement, double weight)

Description

This function creates a new numerical dimension element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension to create the element in.`
`element`	`The element to create.`
`parentElement`	`The parent element under which the new element should be created. If empty, the element will be created on the top level.`
`weight`	`The weight used to aggregate the new element into its parent. Only used if parent element is provided.`

Return Value

True, if the element was created, false if an error occurred.

OLAPCreatePooledConnection

Declaration

OLAPConnection OLAPCreatePooledConnection(string server, string user, string password)

Description

Returns an OLAP connection from the OLAP connection pool. This function is deprecated. Use OLAPCreatePooledNamedConnection() instead.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`server`	`The server to connect to, in the format server name/database name.`
`user`	`The user to connect with.`
`password`	`The user's password.`

Return Value

A pooled connection object.

OLAPCreatePooledConnection

Declaration

OLAPConnection OLAPCreatePooledConnection(string server, string ticket)

Description

Returns an OLAP connection from the OLAP connection pool. This function is deprecated. Use OLAPCreatePooledNamedConnection() instead.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`server`	`The server to connect to, in the format server name/database name.`
`ticket`	`The ticket to connect.`

Return Value

A pooled connection object.

OLAPCreatePooledConnection

Declaration

OLAPConnection OLAPCreatePooledConnection(string connectionString)

Description

Returns a pooled OLAP connection from the OLAP connection pool using a database connection string. The connection string supports these properties: database, user, password, and ticket. You must separate the properties using semicolons. The database property is required. In addition, you must either provide a user and password or ticket. This function is deprecated. Use OLAPCreatePooledNamedConnection() instead.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connectionString`	`The database connection string.`

Return Value

A new OLAP connection.

OLAPCreatePooledNamedConnection

Declaration

OLAPConnection OLAPCreatePooledNamedConnection(string dataConnectionName)

Description

Returns a pooled OLAP connection from the OLAP connection pool using a database connection name.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dataConnectionName`	`The data connection name.`

Return Value

A new OLAP connection.

OLAPCreatePrefixedNumericalElement

Declaration

string OLAPCreatePrefixedNumericalElement(OLAPConnection connection, string dimension, string hierarchy, string prefix, int digits)

Description

Adds a numerical element atomically.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy. If empty, a default hierarchy is used.`
`prefix`	`Element name prefix.`
`digits`	`Number of digits to be appended to the prefix.`

Return Value

Name of the created element.

OLAPCreatePrefixedNumericalElement

Declaration

string OLAPCreatePrefixedNumericalElement(OLAPConnection connection, string dimension, string hierarchy, string prefix, int digits, string parentName, double weight)

Description

Adds a numerical element atomically.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy. If empty, a default hierarchy is used.`
`prefix`	`Element name prefix.`
`digits`	`Number of digits to be appended to the prefix.`
`parentName`	`Name of the element's parent.`
`weight`	`Weight of the new element.`

Return Value

Name of the created element.

OLAPCreatePrefixedTextualElement

Declaration

string OLAPCreatePrefixedTextualElement(OLAPConnection connection, string dimension, string hierarchy, string prefix, int digits)

Description

Adds a textual element atomically.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy. If empty, a default hierarchy is used.`
`prefix`	`Element name prefix.`
`digits`	`Number of digits to be appended to the prefix.`

Return Value

Name of the created element.

OLAPCreatePrefixedTextualElement

Declaration

string OLAPCreatePrefixedTextualElement(OLAPConnection connection, string dimension, string hierarchy, string prefix, int digits, string parentName, double weight)

Description

Adds a textual element atomically.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy. If empty, a default hierarchy is used.`
`prefix`	`Element name prefix.`
`digits`	`Number of digits to be appended to the prefix.`
`parentName`	`Name of the element's parent.`
`weight`	`Weight of the new element.`

Return Value

Name of the created element.

OLAPCreateSplashCommand

Declaration

OLAPSplashCommand OLAPCreateSplashCommand(double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero)

Description

Creates OLAP splash command.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`

Return Value

OLAP splash command.

OLAPCreateSplashCommand

Declaration

OLAPSplashCommand OLAPCreateSplashCommand(double value, string mode)

Description

Creates OLAP splash command. Uses default values for rounding (true), decimals (2) and doNotDeleteOnZero (false).

Supported Runtime Versions

5.0


`Parameters`	`Description`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`

Return Value

OLAP splash command.

OLAPCreateStringAttributeTableField

Declaration

void OLAPCreateStringAttributeTableField(OLAPAttributeTable attributeTable, string attributeName, string attributeDescription, int attributeLength)

Description

Creates a string attribute table field for a certain attribute table.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`attributeTable`	`The attribute table to add the field to.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`
`attributeLength`	`Maximum length of the attribute to be created`

Return Value

Does not return a value.

OLAPCreateStringAttributeTableField

Declaration

void OLAPCreateStringAttributeTableField(OLAPConnection connection, string dimension, int tableIndex, string attributeName, string attributeDescription)

Description

Not supported anymore, throws an exception. Creates a string attribute table field for a certain attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension to create attribute table field for.`
`tableIndex`	`Index of the attribute table to create field for.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateStringAttributeTableField

Declaration

void OLAPCreateStringAttributeTableField(OLAPConnection connection, string dimension, int tableIndex, string attributeName, string attributeDescription, int attributeLength)

Description

Not supported anymore, throws an exception. Creates a string attribute table field for a certain attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension to create attribute table field for.`
`tableIndex`	`Index of the attribute table to create field for.`
`attributeName`	`Name of the attribute to be created.`
`attributeDescription`	`Description of the attribute to be created.`
`attributeLength`	`The maximum length of the attribute to be created.`

Return Value

Does not return a value.

OLAPCreateSubElementBegin

Declaration

void OLAPCreateSubElementBegin(OLAPConnection connection, string elementName)

Description

Starts the creation of a new subelement.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`elementName`	`Name of the subelement to be created.`

Return Value

Does not return a value.

OLAPCreateSubElementEnd

Declaration

void OLAPCreateSubElementEnd(OLAPConnection connection)

Description

Finishes the creation of the current subelement.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

Does not return a value.

OLAPCreateSubsetDefinition

Declaration

void OLAPCreateSubsetDefinition(OLAPConnection connection, string dimension, string hierarchy, string subset, StringList elements)

Description

Creates a subset definition.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`hierarchy`	`The hierarchy to get the elements from.`
`subset`	`Name of the subset to be created.`
`elements`	`List of elements defining the new subset.`

Return Value

Does not return a value.

OLAPCreateSubsetDefinition

Declaration

void OLAPCreateSubsetDefinition(OLAPConnection connection, string dimension, string hierarchy, string subset, StringList elements, int access)

Description

Creates a subset definition.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`hierarchy`	`The hierarchy to get the elements from.`
`subset`	`Name of the subset to be created.`
`elements`	`List of elements defining the new subset.`
`access`	`Access type to the subset.`

Return Value

Does not return a value.

OLAPCreateSystemCube

Declaration

void OLAPCreateSystemCube(OLAPConnection connection, string cubeName, string cubeDescription, string dimension1, string dimension2, ... dimensions[string])

Description

Creates a new OLAP system cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`Name of the cube to be created.`
`cubeDescription`	`The cube's description.`
`dimension1`	`The cube's first dimension.`
`dimension2`	`The cube's second dimension.`
`dimensions`	`The cube's dimensions.`

Return Value

Does not return a value.

OLAPCreateTextDimensionElement

Declaration

bool OLAPCreateTextDimensionElement(OLAPConnection connection, string dimension, string element, string parentElement)

Description

This function creates a new text dimension element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension to create the element in.`
`element`	`The element to create.`
`parentElement`	`The parent element under which the new element should be created. If empty, the element will be created on the top level.`

Return Value

True, if the element was created, false if an error occurred.

OLAPCreateUserCube

Declaration

void OLAPCreateUserCube(OLAPConnection connection, string cubeName, string cubeDescription, string dimension1, string dimension2, ... dimensions[string])

Description

Creates a new OLAP user cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`Name of the cube to be created.`
`cubeDescription`	`The cube's description.`
`dimension1`	`The cube's first dimension.`
`dimension2`	`The cube's second dimension.`
`dimensions`	`The cube's dimensions.`

Return Value

Does not return a value.

OLAPCreateUserCubeDynamic

Declaration

void OLAPCreateUserCubeDynamic(OLAPConnection connection, string cubeName, string cubeDescription, StringArray dimensions)

Description

Creates a new OLAP user cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`Name of the cube to be created.`
`cubeDescription`	`The cube's description.`
`dimensions`	`The cube's dimensions.`

Return Value

Does not return a value.

OLAPCubeCacheHasContextValue

Declaration

bool OLAPCubeCacheHasContextValue(OLAPCubeCache cache, ... elements[string])

Description

Checks whether a context (a combination of dimension elements) holds a value.

Supported Runtime Versions

1.0


`Parameters`	`Description`
`cache`	`The OLAPCubeCache to be checked.`
`elements`	`The list of elements, one for each dimension of the cube.`

Return Value

True, if the context contains a value.

OLAPCubeCacheHasContextValue

Declaration

bool OLAPCubeCacheHasContextValue(OLAPCubeCache cache, string element1, ... elements[string])

Description

Checks whether a context (a combination of dimension elements) holds a value.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`cache`	`The OLAPCubeCache to be checked.`
`element1`	`The first element describing the context.`
`elements`	`The list of elements, one for each dimension of the cube.`

Return Value

True, if the context contains a value.

OLAPCubeCacheHasValue

Declaration

bool OLAPCubeCacheHasValue(OLAPCubeCache cache, string dimension, string value)

Description

Checks whether a certain value occurs in a certain dimension.

Supported Runtime Versions

1.0


`Parameters`	`Description`
`cache`	`The OLAPCubeCache to be checked.`
`dimension`	`Name of the dimension to be checked.`
`value`	`Value to be checked.`

Return Value

True, if the value occurs in the dimension.

OLAPCubeCacheHasValue

Declaration

bool OLAPCubeCacheHasValue(OLAPCubeCache cache, int dimensionIndex, string element)

Description

Checks whether an OLAPCubeCache indicates that a specified element of a dimension has values.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`cache`	`The OLAPCubeCache to be used.`
`dimensionIndex`	`Index of the dimension to be checked as provided for OLAPFillCubeCache.`
`element`	`The element corresponding to the dimension index to be checked.`

Return Value

True, if the element of the specified dimension has values.

OLAPCubeExists

Declaration

bool OLAPCubeExists(OLAPConnection connection, string cube)

Description

Checks whether a cube exists.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cube`	`The cube to check.`

Return Value

True, if the cube exists, false otherwise.

OLAPDeleteAttributeTable

Declaration

void OLAPDeleteAttributeTable(OLAPConnection connection, string dimension, int tableIndex)

Description

Deletes an attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension to delete an attribute table for.`
`tableIndex`	`Index of the attribute table to be deleted.`

Return Value

Does not return a value.

OLAPDeleteCube

Declaration

void OLAPDeleteCube(OLAPConnection connection, string cubeName)

Description

Deletes an OLAP cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`Name of the cube to be deleted.`

Return Value

Does not return a value.

OLAPDeleteDataArea

Declaration

void OLAPDeleteDataArea(OLAPDataArea dataarea)

Description

Deletes all cells contained in a data area.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`dataarea`	`The data area to delete.`

Return Value

Does not return a value.

OLAPDeleteDimension

Declaration

void OLAPDeleteDimension(OLAPConnection connection, string dimensionName)

Description

Deletes a dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to be deleted.`

Return Value

Does not return a value.

OLAPDeleteDimensionElement

Declaration

bool OLAPDeleteDimensionElement(OLAPConnection connection, string dimension, string element)

Description

This function deletes a dimension element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension to delete the element from.`
`element`	`The element to delete.`

Return Value

True, if the element was deleted, false if an error occurred.

OLAPDeleteHierarchy

Declaration

int OLAPDeleteHierarchy(OLAPConnection connection, string dimensionName, string hierarchyName, bool throwException)

Description

Deletes a hierarchy from a dimension.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPDeleteHierarchyElement

Declaration

int OLAPDeleteHierarchyElement(OLAPConnection connection, string dimensionName, string hierarchyName, string hierarchyElement, bool throwException)

Description

Delete an element from a hierarchy.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`hierarchyElement`	`An element to be deleted. Both simple and composite names are supported. If the element name is composite, then the hierarchy name must match the hierarchy in the 'hierarchyName' parameter.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPDeleteHierarchyElements

Declaration

int OLAPDeleteHierarchyElements(OLAPConnection connection, string dimensionName, string hierarchyName, StringList hierarchyElementsFlatList, bool throwException)

Description

Deletes elements from a hierarchy. This overload does not allow you to control atomicity. Partial failures are ignored.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`hierarchyElementsFlatList`	`A list of elements to be deleted. Both simple and composite names are supported. If the element name is composite, then the hierarchy name must match the hierarchy in the 'hierarchyName' parameter.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPDeleteHierarchyElements

Declaration

StringListList OLAPDeleteHierarchyElements(OLAPConnection connection, string dimensionName, string hierarchyName, StringList hierarchyElementsFlatList, bool throwException, bool breakOnError)

Description

Deletes elements from a hierarchy. This overload makes it possible to control atomicity of the request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension.`
`hierarchyName`	`Name of the hierarchy.`
`hierarchyElementsFlatList`	`A list of elements to be deleted.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`
`breakOnError`	`Controls the atomicity of the request. If True, partial failure makes the whole request fail. If False, atomicity is suppressed and a list of partial failures is returned.`

Return Value

Instance of StringListList that carries information about partial errors. If no error occurred, the StringListList is empty. In case of any partial errors, it contains the StringList instance for each partial failure. Each StringList contains six strings with this meaning [position in the command buffer, error code, operation type, element1, element2, error message].

OLAPDeleteParentElement

Declaration

int OLAPDeleteParentElement(OLAPConnection connection, string dimension, string hierarchy, string element, string oldParent, bool throwException)

Description

Deletes a parent-child relationship between one parent and one element. The element moves one level up.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`element`	`Child element.`
`oldParent`	`Parent element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPDeleteParentElement

Declaration

int OLAPDeleteParentElement(OLAPConnection connection, string dimension, string hierarchy, StringList elements, string oldParent, bool throwException)

Description

Deletes a parent-child relationship between one parent and many elements. The elements move one level up. This overload does not allow you to control atomicity. Partial failures are ignored.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`elements`	`Child elements.`
`oldParent`	`Parent element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPDeleteParentElement

Declaration

StringListList OLAPDeleteParentElement(OLAPConnection connection, string dimension, string hierarchy, StringList elements, string oldParent, bool throwException, bool breakOnError)

Description

Deletes a parent-child relationship between one parent and many elements. The elements move one level up. This overload makes it possible to control atomicity of the request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Name of the dimension.`
`hierarchy`	`Name of the hierarchy.`
`elements`	`Child elements.`
`oldParent`	`Parent element.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`
`breakOnError`	`Controls the atomicity of the request. If True, partial failure makes the whole request fail. If False, atomicity is suppressed and a list of partial failures is returned.`

Return Value

Instance of StringListList that carries information about partial errors. If no error occurred, the StringListList is empty. In case of any partial errors, it contains the StringList instance for each partial failure. Each StringList contains six strings with this meaning [position in the command buffer, error code, operation type, element1, element2, error message].

OLAPDeleteSubsetDefinition

Declaration

void OLAPDeleteSubsetDefinition(OLAPConnection connection, string dimension, string subset)

Description

Deletes a subset

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`subset`	`The name of the subset to be deleted.`

Return Value

Does not return a value.

OLAPDimensionElementExists

Declaration

bool OLAPDimensionElementExists(OLAPConnection connection, string dimension, string element)

Description

Checks whether a dimension element exists.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension that should contain the element.`
`element`	`The element to check. It supports both simple and composite names.`

Return Value

True, if the element exists, false otherwise.

OLAPDimensionExists

Declaration

bool OLAPDimensionExists(OLAPConnection connection, string dimension)

Description

Checks whether a dimension exists.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension to check.`

Return Value

True, if the dimension exists, false otherwise.

OLAPDisableBreakOnError

Declaration

void OLAPDisableBreakOnError(OLAPCellWriteBuffer buffer)

Description

Disables BreakOnError support for an OLAPCellWriteBuffer. BreakOnError is enabled by default.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to disable BreakOnError for.`

Return Value

Does not return a value.

OLAPDisableHierarchies

Declaration

void OLAPDisableHierarchies(OLAPCellWriteBuffer buffer)

Description

Disables alternate hierarchies support for an OLAPCellWriteBuffer. Alternate hierarchies are disabled by default.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to disable alternate hierarchies for.`

Return Value

Does not return a value.

OLAPDisconnect

Declaration

void OLAPDisconnect(OLAPConnection connection)

Description

Disconnects an OLAP connection.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The connection to disconnect.`

Return Value

Does not return a value.

OLAPDisconnectAllPooledConnections

Declaration

void OLAPDisconnectAllPooledConnections()

Description

Disconnects all pooled OLAP connections.

Supported Runtime Versions

3.0, 4.0, 5.0

Parameters

The function has no parameters.

Return Value

Does not return a value.

OLAPDisconnectPooledConnection

Declaration

void OLAPDisconnectPooledConnection(OLAPConnection connection)

Description

Disconnects a pooled OLAP connection.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The connection to disconnect.`

Return Value

Does not return a value.

OLAPElementListAddElement

Declaration

bool OLAPElementListAddElement(OLAPElementList list, OLAPElement element)

Description

Adds an element to an OLAPElementList.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`list`	`The list to add the element to.`
`element`	`The element to be added.`

Return Value

True, if the element was added, false otherwise.

OLAPElementListContainsElement

Declaration

bool OLAPElementListContainsElement(OLAPElementList list, OLAPElement element)

Description

Indicates whether an element is contained in an element list.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`list`	`The list to check.`
`element`	`The element to check.`

Return Value

True, if element is contained in list, false otherwise.

OLAPElementListContainsElement

Declaration

bool OLAPElementListContainsElement(OLAPElementList list, string element)

Description

Indicates whether an element with a specific name is contained in an element list.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`list`	`The list to check.`
`element`	`The element to check.`

Return Value

True, if element is contained in list, false otherwise.

OLAPElementListRemoveElement

Declaration

bool OLAPElementListRemoveElement(OLAPElementList list, OLAPElement element)

Description

Removes an element from an OLAPElementList.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`list`	`The list to remove the element from.`
`element`	`The element to be removed.`

Return Value

True, if the element could be removed, false otherwise.

OLAPElementListRemoveElement

Declaration

bool OLAPElementListRemoveElement(OLAPElementList list, string element)

Description

Removes an element from an OLAPElementList.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`list`	`The list to remove the element from.`
`element`	`The element to be removed.`

Return Value

True, if the element could be removed, false otherwise.

OLAPEnableBreakOnError

Declaration

void OLAPEnableBreakOnError(OLAPCellWriteBuffer buffer)

Description

Enables BreakOnError support for an OLAPCellWriteBuffer. BreakOnError is enabled by default.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to enable BreakOnError for.`

Return Value

Does not return a value.

OLAPEnableHierarchies

Declaration

void OLAPEnableHierarchies(OLAPCellWriteBuffer buffer)

Description

Enables alternate hierarchies support for an OLAPCellWriteBuffer. Alternate hierarchies are disabled by default.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to enable alternate hierarchies for.`

Return Value

Does not return a value.

OLAPExecuteSplashCommand

Declaration

void OLAPExecuteSplashCommand(OLAPConnection connection, OLAPSplashCommand command)

Description

Executes a given command. Throws an exception in case of an error.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`command`	`Command to execute.`

Return Value

Does not return a value.

OLAPFillCubeCache

Declaration

void OLAPFillCubeCache(OLAPConnection connection, OLAPCubeCache cache, string dimension1, ... dimensions[string])

Description

Fills an OLAPCubeCache with information about the data in the cube as specified when creating the cache.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`OlapConnection to be used for accessing the OLAP server.`
`cache`	`The cache to be filled.`
`dimension1`	`Name of first dimension to cache information for.`
`dimensions`	`Name of remaining dimensions to cache information for.`

Return Value

Does not return a value.

OLAPGetApplicationName

Declaration

string OLAPGetApplicationName(OLAPConnection conn)

Description

Returns name of the application that owns the olap model.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`conn`	`Database connection.`

Return Value

Application name of the olap model.

OLAPGetAttributeDecimals

Declaration

int OLAPGetAttributeDecimals(OLAPAttribute attribute)

Description

Gets an attribute's number of decimals.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`attribute`	`The attribute to return number of decimals for.`

Return Value

The attribute's number of decimals.

OLAPGetAttributeLength

Declaration

int OLAPGetAttributeLength(OLAPAttribute attribute)

Description

Gets an attribute's length.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`attribute`	`The attribute to return length for.`

Return Value

The attribute's length.

OLAPGetAttributeTableIndex

Declaration

int OLAPGetAttributeTableIndex(OLAPAttributeTable attributeTable)

Description

Returns an attribute table's index.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`attributeTable`	`Attribute table to return index of.`

Return Value

The attribute table's index.

OLAPGetAttributeTableList

Declaration

OLAPAttributeTableList OLAPGetAttributeTableList(OLAPDimension dimension)

Description

Returns a list of all attribute tables belonging to a certain dimension.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`dimension`	`The dimension to get all attribute tables for.`

Return Value

A list of all attribute tables belonging to dimension.

OLAPGetAttributeTableName

Declaration

string OLAPGetAttributeTableName(OLAPAttributeTable attributeTable)

Description

Returns an attribute table's name. If the table name is empty, the table's index will be returned.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`attributeTable`	`Attribute table to return name of.`

Return Value

The attribute table's name.

OLAPGetAttributeType

Declaration

string OLAPGetAttributeType(OLAPAttribute attribute)

Description

Gets an attribute's type as string. Can be bool, double, string, or DateTime.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`attribute`	`The attribute to return type for.`

Return Value

The attribute's type.

OLAPGetBoolAttribute

Declaration

bool OLAPGetBoolAttribute(OLAPConnection connection, OLAPElement element, string attributeName)

Description

Returns the value of a certain attribute as a bool data type.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to read.`

Return Value

The value that is read.

OLAPGetBoolAttribute

Declaration

bool OLAPGetBoolAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName)

Description

Returns the value of a certain attribute as a bool data type.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be read.`

Return Value

The value that is read.

OLAPGetChildElementList

Declaration

OLAPElementList OLAPGetChildElementList(OLAPConnection connection, string dimension, string element, bool onlyBaseElements)

Description

Receives a flat list of all child elements of the specified element for a specific dimension. Can be used with the 'cached' keyword.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`element`	`The element to get the child elements from. This element itself will not be included in the list.`
`onlyBaseElements`	`If true, only base elements will be returned. Otherwise, all elements from the dimension will be included.`

Return Value

A list of all child elements.

OLAPGetCube

Declaration

OLAPCube OLAPGetCube(OLAPConnection connection, string cubeName)

Description

Returns a certain cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The connection to be used for looking up the cube.`
`cubeName`	`Name of the cube to be returned.`

Return Value

The cube named cubeName.

OLAPGetCubeList

Declaration

OLAPCubeList OLAPGetCubeList(OLAPConnection connection)

Description

Returns a list of all cubes known to a certain connection.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The connection to return all cubes for.`

Return Value

A list of all cubes known to a certain connection.

OLAPGetCubeName

Declaration

string OLAPGetCubeName(OLAPCube cube)

Description

Returns the name of the cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`cube`	`Cube to return name of.`

Return Value

The name of the cube.

OLAPGetCubeType

Declaration

string OLAPGetCubeType(OLAPCube cube)

Description

Retrieves the type of a cube.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`cube`	`Instance of OlapCube.`

Return Value

The type of cube as string. U for user cube, S for system cube, D for dimension access control cube, A for cube access control cube.

OLAPGetDateTimeAttribute

Declaration

DateTime OLAPGetDateTimeAttribute(OLAPConnection connection, OLAPElement element, string attributeName)

Description

Returns the value of a certain attribute as a DateTime data type.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to read.`

Return Value

The value that is read.

OLAPGetDateTimeAttribute

Declaration

DateTime OLAPGetDateTimeAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName)

Description

Returns the value of a certain attribute as a DateTime data type.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be read.`

Return Value

The value that is read.

OLAPGetDefaultHierarchy

Declaration

string OLAPGetDefaultHierarchy(OLAPConnection connection, string dimensionName, bool throwException)

Description

Returns a dimension's default hierarchy.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to get the default hierarchy for.`
`throwException`	`If true, the function throws an exception in case of errors.`

Return Value

The dimension's default hierarchy.

OLAPGetDimension

Declaration

OLAPDimension OLAPGetDimension(OLAPConnection connection, string dimensionName)

Description

Returns a certain dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The connection to be used for looking up the dimension.`
`dimensionName`	`Name of the dimension to be returned.`

Return Value

The dimension named dimensionName.

OLAPGetDimensionElement

Declaration

OLAPElement OLAPGetDimensionElement(OLAPConnection connection, string dimension, string element, bool throwException)

Description

Receives an element from a dimension.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to retrieve the data from.`
`dimension`	`The dimension to receive the element from.`
`element`	`The name of the element to receive. It supports both simple and composite names.`
`throwException`	`Indicates whether to throw an exception if the function fails to receive the element.`

Return Value

The element from the specified dimension.

OLAPGetDimensionElement

Declaration

OLAPElement OLAPGetDimensionElement(OLAPConnection connection, string dimension, string element)

Description

Receives an element from a dimension.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to retrieve the data from.`
`dimension`	`The dimension to receive the element from.`
`element`	`The name of the element to receive. It supports both simple and composite names.`

Return Value

The element from the specified dimension.

OLAPGetDimensionList

Declaration

OLAPDimensionList OLAPGetDimensionList(OLAPCube cube)

Description

Returns a list of all dimensions of a certain cube.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`cube`	`The cube to return all dimensions for.`

Return Value

A list of all dimensions belonging to a certain cube.

OLAPGetDimensionList

Declaration

OLAPDimensionList OLAPGetDimensionList(OLAPConnection connection)

Description

Returns a list of all dimensions of a certain server.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`Connection to the OLAP server to return all dimensions for.`

Return Value

A list of all dimensions belonging to a certain server.

OLAPGetDimensionSubsetElements

Declaration

OLAPElementList OLAPGetDimensionSubsetElements(OLAPConnection connection, string dimension, string hierarchy, string subset)

Description

Gets a list of elements from a dimension subset.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`hierarchy`	`The hierarchy to get the elements from.`
`subset`	`The subset of the dimension to get.`

Return Value

A list of OLAP elements.

OLAPGetDimensionSubsetElements

Declaration

OLAPElementList OLAPGetDimensionSubsetElements(OLAPConnection connection, string dimension, string subset)

Description

Gets a list of elements from a dimension subset.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`subset`	`The subset of the dimension to get.`

Return Value

A list of OLAP elements.

OLAPGetDirectChildrenList

Declaration

OLAPElementList OLAPGetDirectChildrenList(OLAPConnection connection, string dimension, string element, bool onlyBaseElements)

Description

Receives a flat list of all direct child elements of the specified element for a specific dimension. Can be used with the 'cached' keyword.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to receive the data from.`
`dimension`	`The dimension to receive the elements from.`
`element`	`The element to receive the direct child elements from. This element itself will not be included in the list. It supports both simple and composite names.`
`onlyBaseElements`	`If true, only base elements will be returned.`

Return Value

A list of all direct child elements.

OLAPGetDoubleAttribute

Declaration

double OLAPGetDoubleAttribute(OLAPConnection connection, OLAPElement element, string attributeName)

Description

Returns the value of a certain attribute as a double data type.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to read.`

Return Value

The value that is read.

OLAPGetDoubleAttribute

Declaration

double OLAPGetDoubleAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName)

Description

Returns the value of a certain attribute as a double data type.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be read.`

Return Value

The value that is read.

OLAPGetElementList

Declaration

OLAPElementList OLAPGetElementList(OLAPConnection connection, string dimension, string hierarchyName, bool onlyBaseElements, bool cache, bool throwException)

Description

Returns a list of OLAP elements.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to receive the data from.`
`dimension`	`The dimension to receive the elements from.`
`hierarchyName`	`The hierarchy to receive the elements from.`
`onlyBaseElements`	`If true, only base elements will be returned. Otherwise, all elements from the dimension will be included.`
`cache`	`If true, the function's result will be cached.`
`throwException`	`If true, the function raises an exception in case of an error.`

Return Value

An OLAPElementList that contains the specified elements.

OLAPGetElementList

Declaration

OLAPElementList OLAPGetElementList(OLAPConnection connection, string dimension, bool onlyBaseElements)

Description

Receives a flat list of elements for a specific dimension. Can be used with the 'cached' keyword.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`onlyBaseElements`	`If true, only base elements will be returned. Otherwise, all elements from the dimension will be included.`

Return Value

A list of OLAP elements.

OLAPGetElementList

Declaration

OLAPElementList OLAPGetElementList(OLAPElement element)

Description

Creates an OLAPElementList that contains the specified element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`element`	`The element to put into the list.`

Return Value

An OLAPElementList that contains the specified element.

OLAPGetElementsAttributesValues

Declaration

StringListList OLAPGetElementsAttributesValues(OLAPConnection connection, string dimensionName, string hierarchy, OLAPElementList elementList, StringList attributeList)

Description

Returns the value of multiple attributes for multiple elements.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`hierarchy`	`Name of the hierarchy to read from.`
`elementList`	`The list of elements to read the attributes from.`
`attributeList`	`The list of attributes to be read for each element.`

Return Value

A StringListList that contains a StringList for each specified element. Each StringList contains values of required attributes for given element.

OLAPGetElementsAttributeValues

Declaration

StringList OLAPGetElementsAttributeValues(OLAPConnection connection, string dimensionName, string hierarchy, OLAPElementList elementList, string attribute)

Description

Returns the value of an attribute for multiple elements.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`hierarchy`	`Name of the hierarchy to read from.`
`elementList`	`The list of elements to read the attributes from.`
`attribute`	`Name of the attribute to be read.`

Return Value

A list of string values of the attributes for each element.

OLAPGetElementType

Declaration

string OLAPGetElementType(OLAPConnection connection, OLAPElement element)

Description

Gets the type of an element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`element`	`The element to get the type for.`

Return Value

The type of the element, which can be N for leaf element, C for consolidated element, R for rule element, and T for text element.

OLAPGetElementWeight

Declaration

double OLAPGetElementWeight(OLAPConnection connection, string dimension, string element, string parentElement)

Description

Gets the weight of a dimension element for a specific parent element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension that must contain the element and the parent element.`
`element`	`The element to get the weight for. It supports both simple and composite names.`
`parentElement`	`The parent to get the weight for.`

Return Value

The weight used to aggregate the element into the parent element.

OLAPGetErrorDescription

Declaration

string OLAPGetErrorDescription(OLAPConnection connection, int errorId)

Description

Returns a textual description of an OLAP error identified by its error ID.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`errorId`	`Error ID of the OLAP error to receive a textual description for.`

Return Value

Textual description of the OLAP error.

OLAPGetErrorDescription

Declaration

string OLAPGetErrorDescription(OLAPConnection connection, int errorId, string languageCode)

Description

Returns a textual description of an OLAP error identified by its error ID.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`errorId`	`Error ID of the OLAP error to receive a textual description for.`
`languageCode`	`Code of the language to return the error message for.`

Return Value

Textual description of the OLAP error.

OLAPGetHierarchies

Declaration

StringList OLAPGetHierarchies(OLAPConnection connection, string dimension)

Description

Returns a list of names of all hierarchies of a certain dimension.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`Connection to an OLAP server.`
`dimension`	`Name of a dimension.`

Return Value

A list of names of all hierarchies belonging to a certain dimension.

OLAPGetIntAttribute

Declaration

int OLAPGetIntAttribute(OLAPConnection connection, OLAPElement element, string attributeName)

Description

Returns the value of a certain attribute as an int data type.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to read.`

Return Value

The value that is read.

OLAPGetIntAttribute

Declaration

int OLAPGetIntAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName)

Description

Returns the value of a certain attribute as an int data type.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be read.`

Return Value

The value that is read.

OLAPGetLevelElements

Declaration

OLAPElementList OLAPGetLevelElements(OLAPConnection connection, string dimension, int level, bool onlyBaseElements)

Description

Returns all elements of a given dimension at a certain level.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to receive the data from.`
`dimension`	`Name of the dimension to return elements for.`
`level`	`Level of the children to be returned.`
`onlyBaseElements`	`If true, only base elements will be returned.`

Return Value

All child elements at a certain level.

OLAPGetLevelElements

Declaration

OLAPElementList OLAPGetLevelElements(OLAPConnection connection, string dimension, string parentElement, int level, bool onlyBaseElements)

Description

Returns all descendants having a certain level relative to given parentLevel.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to receive the data from.`
`dimension`	`Dimension of the parent element.`
`parentElement`	`Name of the parent element. It supports both simple and composite names.`
`level`	`Level of the children to be returned.`
`onlyBaseElements`	`If true, only base elements will be returned.`

Return Value

All child elements at a certain level.

OLAPGetLevelElementsWithHierarchy

Declaration

OLAPElementList OLAPGetLevelElementsWithHierarchy(OLAPConnection connection, string dimension, string hierarchy, int level, bool onlyBaseElements)

Description

Returns all elements of a given dimension at a certain level.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to receive the data from.`
`dimension`	`Name of the dimension to return elements for.`
`hierarchy`	`Name of the hierarchy to return elements for.`
`level`	`Level of the children to be returned.`
`onlyBaseElements`	`If true, only base elements will be returned.`

Return Value

All child elements at a certain level.

OLAPGetParentElementList

Declaration

OLAPElementList OLAPGetParentElementList(OLAPConnection connection, OLAPElement element)

Description

Gets a list of all direct parent elements of the specified element.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`element`	`The element to get the child elements from. This element itself will not be included in the list.`

Return Value

A list of all parent elements.

OLAPGetSessionId

Declaration

string OLAPGetSessionId(OLAPConnection connection)

Description

Gets a session ID of the given OLAP connection.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`OLAP connection.`

Return Value

Session ID.

OLAPGetStringAttribute

Declaration

string OLAPGetStringAttribute(OLAPConnection connection, OLAPElement element, string attributeName)

Description

Returns the value of a certain attribute as a string.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to read.`

Return Value

The value that is read.

OLAPGetStringAttribute

Declaration

string OLAPGetStringAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName)

Description

Returns the value of a certain attribute as a string.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be read.`

Return Value

The value that is read.

OLAPGetSubsetAccess

Declaration

int OLAPGetSubsetAccess(OLAPConnection connection, string dimension, string subset)

Description

Get subset access.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`subset`	`The subset of the dimension to get.`

Return Value

Subset access type.

OLAPGetSubsetHierarchy

Declaration

string OLAPGetSubsetHierarchy(OLAPConnection connection, string dimension, string subset)

Description

Gets the subset hierarchy.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`subset`	`The subset of the dimension to get.`

Return Value

Hierarchy name.

OLAPGetSubsets

Declaration

StringList OLAPGetSubsets(OLAPConnection connection, string dimension, string hierarchy, OlapSubsetAccess accessType)

Description

Gets a list of names of subsets for a hierarchy on a dimension.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`hierarchy`	`The hierarchy to get the elements from. Use * to list substes from all hierarchies on a given dimension.`
`accessType`	`Access type. Use constants OlapSubsetAccessPublic, OlapSubsetAccessPrivate and OlapSubsetAccessAll.`

Return Value

List of subsets on a given dimension and hierarchy that have the specified access type.

OLAPGetTopLevelNumericElements

Declaration

OLAPElementList OLAPGetTopLevelNumericElements(OLAPConnection connection, string dimension, string hierarchy)

Description

Gets all numeric elements that are on the top level of a dimension.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`hierarchy`	`The hierarchy to get the elements from.`

Return Value

A list with all top level elements.

OLAPGetTopLevelNumericElements

Declaration

OLAPElementList OLAPGetTopLevelNumericElements(OLAPConnection connection, string dimension)

Description

Gets all numeric elements that are on the top level of a dimension.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`

Return Value

A list with all top level elements.

OLAPHierarchyExists

Declaration

bool OLAPHierarchyExists(OLAPConnection connection, string dimension, string hierarchy)

Description

Checks whether a hierarchy exists in a particular dimension.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension to search the hierarchy.`
`hierarchy`	`The hierarchy to check.`

Return Value

True, if the hierarchy exists in a particular dimension, false otherwise.

OLAPIsBaseElement

Declaration

bool OLAPIsBaseElement(OLAPConnection connection, OLAPElement element)

Description

Indicates whether an OLAP element is a base element.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`element`	`The element to check.`

Return Value

True, if element is a base element, false otherwise.

OLAPIsBaseElement

Declaration

bool OLAPIsBaseElement(OLAPConnection connection, string dimensionName, string elementName)

Description

Indicates whether an OLAP element is a base element.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to receive the data from.`
`dimensionName`	`The name of the dimension of the element to check.`
`elementName`	`The name of the element to check. It supports both simple and composite names.`

Return Value

True, if element is a base element, false, otherwise.

OLAPIsCellWritable

Declaration

bool OLAPIsCellWritable(OLAPConnection conn, string cube, StringDictionary cell)

Description

Returns true if cell is writable

Supported Runtime Versions

5.0


`Parameters`	`Description`
`conn`	`Database connection.`
`cube`	`Name of the cube.`
`cell`	`Dictionary of the dimensions and elements.`

Return Value

True if all cells are accessible and writable.

OLAPMergeDistinct

Declaration

OLAPElementList OLAPMergeDistinct(OLAPElementList list1, OLAPElementList list2)

Description

Merges two OLAPElementList objects and eliminates all duplicate values.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`list1`	`The first list to be merged.`
`list2`	`The second list to be merged.`

Return Value

A new OLAPElementList that contains all values of list1 and list2 except the duplicates.

OLAPModifySubsetDefinition

Declaration

void OLAPModifySubsetDefinition(OLAPConnection connection, string dimension, string hierarchy, string subset, StringList elements)

Description

Modifies a subset definition.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`hierarchy`	`The hierarchy to get the elements from.`
`subset`	`The subset of the dimension to get.`
`elements`	`List of elements defining the new subset.`

Return Value

Does not return a value.

OLAPReleasePooledConnection

Declaration

void OLAPReleasePooledConnection(OLAPConnection connection)

Description

Releases a pooled OLAP connection.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The connection to disconnect.`

Return Value

Does not return a value.

OLAPRemoveParentChildRelationship

Declaration

void OLAPRemoveParentChildRelationship(OLAPEditDimensionRequest request, string childElementName, string parentElementName)

Description

Removes the parent-child relation between two elements.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`The OLAPEditDimensionRequest to be used.`
`childElementName`	`The name of the child element.`
`parentElementName`	`The name of the parent element.`

Return Value

Does not return a value.

OLAPRemoveParentChildRelationship

Declaration

bool OLAPRemoveParentChildRelationship(OLAPConnection connection, string dimension, string elementName, string parentElementName)

Description

Removes parent-child relation between elements.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`Dimension of the element.`
`elementName`	`The element to change the parent of.`
`parentElementName`	`The element's old parent.`

Return Value

True, if the element's parent has been changed. False, if an error has occurred.

OLAPRenameDimensionElement

Declaration

bool OLAPRenameDimensionElement(OLAPConnection connection, string dimension, string element, string newName)

Description

This function renames a dimension element.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimension`	`The dimension that contains the element to rename.`
`element`	`The element to rename.`
`newName`	`The new name of the element.`

Return Value

True, if the element was renamed, false if an error occurred.

OLAPSendRequest

Declaration

bool OLAPSendRequest(OLAPConnection connection, OLAPEditDimensionRequest request, bool ignoreExceptions)

Description

Sends an OlapEditDimensionRequest to the OLAP server. This overload does not allow you to control atomicity. Partial failures are ignored.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`request`	`The request to be sent.`
`ignoreExceptions`	`If true, exceptions will be ignored.`

Return Value

True, if the request has been processed successfully. False, if an error occurred.

OLAPSendRequest

Declaration

StringListList OLAPSendRequest(OLAPConnection connection, OLAPEditDimensionRequest request, bool ignoreExceptions, bool breakOnError)

Description

Sends an OlapEditDimensionRequest to the OLAP server. This overload makes it possible to control atomicity of the request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`request`	`The request to be sent.`
`ignoreExceptions`	`If true, exceptions will be ignored.`
`breakOnError`	`Controls the atomicity of the request. If True, partial failure makes the whole request fail. If False, atomicity is suppressed and a list of partial failures is returned.`

Return Value

Instance of StringListList that carries information about partial errors. If no error occurred, the StringListList is empty. In case of any partial errors, it contains the StringList instance for each partial failure. Each StringList contains six strings with this meaning [position in the command buffer, error code, operation type, element1, element2, error message].

OLAPSetAutoCommit

Declaration

void OLAPSetAutoCommit(OLAPCellWriteBuffer buffer, bool autoCommit)

Description

Controls the auto-commit behavior of an OLAPCellWriteBuffer.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to set the auto-commit behavior for.`
`autoCommit`	`If true, auto-commit will be enabled. If false, auto-commit will be disabled.`

Return Value

Does not return a value.

OLAPSetBoolAttribute

Declaration

bool OLAPSetBoolAttribute(OLAPConnection connection, OLAPElement element, string attributeName, bool value)

Description

Sets the attribute value of type bool. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to write.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetBoolAttribute

Declaration

bool OLAPSetBoolAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName, bool value)

Description

Sets the attribute value of type bool. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be set.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetDataAreaValue

Declaration

void OLAPSetDataAreaValue(OLAPDataArea dataarea, double value)

Description

Sets all values of a data area.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`dataarea`	`The data area to write.`
`value`	`The value to write.`

Return Value

Does not return a value.

OLAPSetDateTimeAttribute

Declaration

bool OLAPSetDateTimeAttribute(OLAPConnection connection, OLAPElement element, string attributeName, DateTime value)

Description

Sets the value of a certain DateTime attribute. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name. Only the date value is set, because time is not supported on attributes in OLAP.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to write.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetDateTimeAttribute

Declaration

bool OLAPSetDateTimeAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName, DateTime value)

Description

Sets the value of a certain DateTime attribute. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name. Only the date value is set, because time is not supported on attributes in OLAP.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be set.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetDefaultHierarchy

Declaration

int OLAPSetDefaultHierarchy(OLAPConnection connection, string dimensionName, string hierarchyName, bool throwException)

Description

Sets a dimension's default hierarchy.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to set the default hierarchy for.`
`hierarchyName`	`Default hierarchy to be set.`
`throwException`	`If true, the function throws an exception in case of errors.`

Return Value

Error/status code that indicates if the operation succeeds.

OLAPSetDoubleAttribute

Declaration

bool OLAPSetDoubleAttribute(OLAPConnection connection, OLAPElement element, string attributeName, double value)

Description

Sets the attribute value of type double. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to write.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetDoubleAttribute

Declaration

bool OLAPSetDoubleAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName, double value)

Description

Sets the attribute value of type double. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be set.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetIntAttribute

Declaration

bool OLAPSetIntAttribute(OLAPConnection connection, OLAPElement element, string attributeName, int value)

Description

Sets the value of a certain integer attribute. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to write.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetIntAttribute

Declaration

bool OLAPSetIntAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName, int value)

Description

Sets the value of a certain integer attribute. The function searches the attribute field in all attribute tables and takes the first attribute that fits the attribute name.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be set.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetLogging

Declaration

void OLAPSetLogging(OLAPCellWriteBuffer buffer, bool loggingEnabled)

Description

Controls the logging behavior of an OLAPCellWriteBuffer. Logging is enabled by default. Disabling logging can lead to performance improvements.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to set the logging behavior for.`
`loggingEnabled`	`If true, logging will be enabled. If false, logging will be disabled.`

Return Value

Does not return a value.

OLAPSetMaxUncommittedValues

Declaration

void OLAPSetMaxUncommittedValues(OLAPCellWriteBuffer buffer, int maxUncommittedValues)

Description

Sets the number of values that lead to the invocation of an auto-commit operation.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`buffer`	`The OLAPCellWriteBuffer to set the maximum number of uncommitted values for.`
`maxUncommittedValues`	`The maximum number of uncommitted values to be set.`

Return Value

Does not return a value.

OLAPSetSplashCommandDoNotDeleteOnZero

Declaration

void OLAPSetSplashCommandDoNotDeleteOnZero(OLAPSplashCommand command, bool doNotDeleteOnZero)

Description

Sets command doNotDeleteOnZero property.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`

Return Value

Does not return a value.

OLAPSetSplashCommandElements

Declaration

void OLAPSetSplashCommandElements(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, StringArray dimensions, StringArray hierarchies, StringArray elements, IntArray distributes)

Description

Defines elements of a given type in the command. Overwrites existing.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimensions`	`Dimensions of the elements.`
`hierarchies`	`Hierarchies of the elements.`
`elements`	`Names of the elements.`
`distributes`	`The values of the Distribute parameter for the Reference or Driver elements (ignored for other).`

Return Value

Does not return a value.

OLAPSetSplashCommandElements

Declaration

void OLAPSetSplashCommandElements(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, StringArray dimensions, StringArray hierarchies, StringArray elements)

Description

Defines elements of a given type in the command. Overwrites existing.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimensions`	`Dimensions of the elements.`
`hierarchies`	`Hierarchies of the elements.`
`elements`	`Names of the elements.`

Return Value

Does not return a value.

OLAPSetSplashCommandElements

Declaration

void OLAPSetSplashCommandElements(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, StringArray dimensions, StringArray elements, IntArray distributes)

Description

Defines elements of a given type in the command. Overwrites existing.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimensions`	`Dimensions of the elements.`
`elements`	`Names of the elements.`
`distributes`	`The values of the Distribute parameter for the Reference or Driver elements (ignored for other).`

Return Value

Does not return a value.

OLAPSetSplashCommandElements

Declaration

void OLAPSetSplashCommandElements(OLAPSplashCommand command, OLAPSplashCommandElementType type, string cube, StringArray dimensions, StringArray elements)

Description

Defines elements of a given type in the command. Overwrites existing.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`type`	`Type of elements (Reference, Driver, Target, Locked).`
`cube`	`The name of the cube.`
`dimensions`	`Dimensions of the elements.`
`elements`	`Names of the elements.`

Return Value

Does not return a value.

OLAPSetSplashCommandRounding

Declaration

void OLAPSetSplashCommandRounding(OLAPSplashCommand command, bool rounding, int decimals)

Description

Sets command rounding property together with decimals.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`

Return Value

Does not return a value.

OLAPSetSplashCommandValue

Declaration

void OLAPSetSplashCommandValue(OLAPSplashCommand command, double value)

Description

Sets value to distribute.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`command`	`Edited command.`
`value`	`The value to distribute.`

Return Value

Does not return a value.

OLAPSetStringAttribute

Declaration

bool OLAPSetStringAttribute(OLAPConnection connection, OLAPElement element, string attributeName, string value)

Description

Sets the value of a certain string attribute.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`element`	`The element to read from.`
`attributeName`	`The attribute to read.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetStringAttribute

Declaration

bool OLAPSetStringAttribute(OLAPConnection connection, string dimensionName, string elementName, string attributeName, string value)

Description

Sets the value of a certain string attribute.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`Name of the dimension to read from.`
`elementName`	`Name of the element to read from. It supports both simple and composite names.`
`attributeName`	`Name of the attribute to be set.`
`value`	`The value to be set.`

Return Value

True, if successful or false, if an error occurred.

OLAPSetSubsetAccess

Declaration

void OLAPSetSubsetAccess(OLAPConnection connection, string dimension, string subset, int access)

Description

Set subset access.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`An OLAP connection to get the data from.`
`dimension`	`The dimension to get the elements from.`
`subset`	`The subset of the dimension to get.`
`access`	`Subset access type. It can be OlapSubsetAccessPublic or OlapSubsetAccessPrivate.`

Return Value

Does not return a value.

OLAPSplashValue

Declaration

bool OLAPSplashValue(OLAPConnection connection, string cubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, string element1, string element2, ... elements[string])

Description

Distributes a value to a calculated cell.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`The name of a cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`element1`	`The first mandatory element.`
`element2`	`The second mandatory element.`
`elements`	`The additional elements depending on the cube.`

Return Value

True, if successful, false if an error occurred.

OLAPSplashValueDynamic

Declaration

int OLAPSplashValueDynamic(OLAPConnection connection, string cubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray reference, StringArray target, bool throwException)

Description

Distributes a value to a calculated cell using a cell reference.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`The name of a cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`reference`	`The reference elements.`
`target`	`The target elements.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPSplashValueDynamic

Declaration

int OLAPSplashValueDynamic(OLAPConnection connection, string referenceCubeName, string targetCubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray reference, StringArray target, bool throwException)

Description

Distributes a value to a calculated cell using a cell reference.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`referenceCubeName`	`The name of the reference cube.`
`targetCubeName`	`The name of the target cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`reference`	`The reference elements.`
`target`	`The target elements.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPSplashValueDynamic

Declaration

int OLAPSplashValueDynamic(OLAPConnection connection, string referenceCubeName, string driverCubeName, string targetCubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray referenceDimensions, StringArray reference, IntArray referenceDistribute, StringArray driverDimensions, StringArray driver, IntArray driverDistribute, StringArray targetDimensions, StringArray target, bool throwException)

Description

Distributes a value to a calculated cell using a cell reference.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`referenceCubeName`	`The name of the reference cube.`
`driverCubeName`	`The name of the driver cube.`
`targetCubeName`	`The name of the target cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`referenceDimensions`	`The reference element dimensions.`
`reference`	`The reference elements.`
`referenceDistribute`	`The values of the Distribute parameter for the reference elements.`
`driverDimensions`	`The driver element dimensions.`
`driver`	`The driver elements.`
`driverDistribute`	`The values of the Distribute parameter for the driver elements.`
`targetDimensions`	`The target element dimensions.`
`target`	`The target elements.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPSplashValueDynamic

Declaration

int OLAPSplashValueDynamic(OLAPConnection connection, string referenceCubeName, string driverCubeName, string targetCubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray referenceDimensions, StringArray referenceHierarchies, StringArray reference, IntArray referenceDistribute, StringArray driverDimensions, StringArray driverHierarchies, StringArray driver, IntArray driverDistribute, StringArray targetDimensions, StringArray targetHierarchies, StringArray target, bool throwException)

Description

Distributes a value to a calculated cell using a cell reference.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`referenceCubeName`	`The name of the reference cube.`
`driverCubeName`	`The name of the driver cube.`
`targetCubeName`	`The name of the target cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`referenceDimensions`	`The reference element dimensions.`
`referenceHierarchies`	`The reference element hierarchies.`
`reference`	`The reference elements.`
`referenceDistribute`	`The values of the Distribute parameter for the reference elements.`
`driverDimensions`	`The driver element dimensions.`
`driverHierarchies`	`The driver element hierarchies.`
`driver`	`The driver elements.`
`driverDistribute`	`The values of the Distribute parameter for the driver elements.`
`targetDimensions`	`The target element dimensions.`
`targetHierarchies`	`The target element hierarchies.`
`target`	`The target elements.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPSplashValueDynamic

Declaration

int OLAPSplashValueDynamic(OLAPConnection connection, string cubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray elements, bool throwException)

Description

Distributes a value to a calculated cell.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`The name of a cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`elements`	`The additional elements depending on the cube.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPSplashValueDynamic

Declaration

bool OLAPSplashValueDynamic(OLAPConnection connection, string cubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray reference, StringArray target)

Description

Distributes a value to a calculated cell using a cell reference.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`The name of a cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`reference`	`The reference elements.`
`target`	`The target elements.`

Return Value

True, if successful, false if an error occurred.

OLAPSplashValueDynamic

Declaration

bool OLAPSplashValueDynamic(OLAPConnection connection, string referenceCubeName, string targetCubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray reference, StringArray target)

Description

Distributes a value to a calculated cell using a cell reference.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`referenceCubeName`	`The name of the reference cube.`
`targetCubeName`	`The name of the target cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`reference`	`The reference elements.`
`target`	`The target elements.`

Return Value

True, if successful, false if an error occurred.

OLAPSplashValueDynamic

Declaration

bool OLAPSplashValueDynamic(OLAPConnection connection, string cubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, StringArray elements)

Description

Distributes a value to a calculated cell.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`The name of a cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`elements`	`The additional elements depending on the cube.`

Return Value

True, if successful, false if an error occurred.

OLAPSplashValueWithException

Declaration

int OLAPSplashValueWithException(OLAPConnection connection, string cubeName, double value, string mode, bool rounding, int decimals, bool doNotDeleteOnZero, bool throwException, string element1, string element2, ... elements[string])

Description

Distributes a value to a calculated cell.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`cubeName`	`The name of a cube.`
`value`	`The value to distribute.`
`mode`	`The allocation mode to distribute the value. You can find the list of possible modes and their documentation in the Cube Splashing chapter of the OLAP SDK documentation. See Software Development Kit - XML API - Cube Functions - Cube Splashing.`
`rounding`	`True if values should be rounded, false if not.`
`decimals`	`The number of decimals to round if rounding is true.`
`doNotDeleteOnZero`	`If true, sending the value 0 will not delete the base cells, but it will write the value 0. Otherwise, sending the value 0 will delete the base cells.`
`throwException`	`Indicates whether a BiSharpRuntime exception is thrown in case of a failure.`
`element1`	`The first required element.`
`element2`	`The second required element.`
`elements`	`The additional elements depending on the cube.`

Return Value

ErrorId as received from the OLAP server. If successful, it returns 0.

OLAPStartLoadFromSource

Declaration

bool OLAPStartLoadFromSource(OLAPConnection connection)

Description

Starts the LoadJobs function to load data on a specific OLAP data connection. The process is just started and does not have to be completed when this function returns.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`

Return Value

True, if successfully started, false if the OLAP server could not start the process.

OLAPUpdateRoles

Declaration

void OLAPUpdateRoles(OLAPConnection conn)

Description

Forces the OLAP database to reread roles from the repository.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`conn`	`Database connection.`

Return Value

Does not return a value.

OLAPXMLRequest

Declaration

string OLAPXMLRequest(OLAPConnection connection, string request)

Description

Sends an XML request to the OLAP server.

Supported Runtime Versions

2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`request`	`The request to send.`

Return Value

The result from the OLAP server, usually an XML document.

ResolveHierarchyName

Declaration

string ResolveHierarchyName(OLAPConnection connection, string uniqueName)

Description

Resolves the name of an element's hierarchy, that is, converts it from XMLA to its native representation.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`uniqueName`	`Unique name to be resolved.`

Return Value

Native equivalent of the hierarchy name.

ResolveUniqueName

Declaration

string ResolveUniqueName(OLAPConnection connection, string uniqueName)

Description

Resolves a unique name, that is, converts it from XMLA to its native representation.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`uniqueName`	`Unique name to be resolved.`

Return Value

Native equivalent of the unique name.

ResolveUniqueNames

Declaration

StringList ResolveUniqueNames(OLAPConnection connection, StringList uniqueNames)

Description

Resolves a list of unique names. That is, converts it from XMLA to its native representation.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`uniqueNames`	`A list of unique names to be resolved.`

Return Value

A list of native names equivalent to the given unique names.

ResolveUniqueNamesWithHierarchy

Declaration

StringList ResolveUniqueNamesWithHierarchy(OLAPConnection connection, StringList uniqueNames)

Description

Resolves a list of unique names. That is, converts it from XMLA to its native composite name representation.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`uniqueNames`	`A list of unique names to be resolved.`

Return Value

A list of native composite names equivalent to the given unique names.

ResolveUniqueNameWithHierarchy

Declaration

string ResolveUniqueNameWithHierarchy(OLAPConnection connection, string uniqueName)

Description

Resolves a unique name, that is, converts it from XMLA to its native composite name representation.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`uniqueName`	`Unique name to be resolved.`

Return Value

Native composite name equivalent of the unique name.

ToStringList

Declaration

StringList ToStringList(string x)

Description

Converts a single string into a StringList.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`x`	`String to be converted into a StringList.`

Return Value

StringList that contains only the parameter 'x'.

ToStringList

Declaration

StringList ToStringList(DataAreaDimensionFilter x)

Description

Converts a single DataAreaDimensionFilter into a StringList.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`x`	`DataAreaDimensionFilter to be converted into a StringList.`

Return Value

StringList that contains only the parameter 'x'.

ToStringList

Declaration

StringList ToStringList(OLAPElement x)

Description

Converts a single OLAPElement into a StringList.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`x`	`OLAPElement to be converted into a StringList.`

Return Value

StringList that contains only the parameter 'x'.

ToStringList

Declaration

StringList ToStringList(OLAPElementList x)

Description

Converts a single OLAPElementList into a StringList.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`x`	`OLAPElementList to be converted into a StringList.`

Return Value

StringList that contains only the parameter 'x'.

ToStringList

Declaration

StringList ToStringList(StringArray x)

Description

Converts a single StringArray into a StringList.

Supported Runtime Versions

4.0, 5.0


`Parameters`	`Description`
`x`	`StringArray to be converted into a StringList.`

Return Value

StringList that contains only the parameter 'x'.

UpdateAttributeDrivenHierarchy

Declaration

void UpdateAttributeDrivenHierarchy(OLAPConnection connection, string dimensionName)

Description

Update attribute driven hierarchy.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`A connection to an OLAP server.`
`dimensionName`	`The name of the dimension which will be updated.`

Return Value

Does not return a value.

XMLACreateConnection

Declaration

XMLAConnection XMLACreateConnection(string url, string olapUser, string olapPassword, string httpUser, string httpPassword, string catalog)

Description

Creates a new OLAP connection using the XMLA protocol. This function is deprecated. Use XMLACreateNamedConnection() instead.

Supported Runtime Versions

4.0

This function is not supported in a cloud environment.


`Parameters`	`Description`
`url`	`URL of a server to connect to.`
`olapUser`	`The user who connects to the OLAP server.`
`olapPassword`	`User's password.`
`httpUser`	`Additional user name to be used for HTTP authentication.`
`httpPassword`	`Additional password to be used for HTTP authentication.`
`catalog`	`The catalog to connect to.`

Return Value

A new XMLA connection object.

XMLACreateConnection

Declaration

XMLAConnection XMLACreateConnection(string url, string olapUser, string olapPassword, string catalog)

Description

Creates a new OLAP connection using the XMLA protocol. This function is deprecated. Use XMLACreateNamedConnection() instead.

Supported Runtime Versions

3.0, 4.0, 5.0

This function is not supported in a cloud environment.


`Parameters`	`Description`
`url`	`URL of a server to connect to.`
`olapUser`	`The user who connects to the OLAP server.`
`olapPassword`	`User's password.`
`catalog`	`The catalog to connect to.`

Return Value

A new XMLA connection object.

XMLACreateConnectionTicket

Declaration

XMLAConnection XMLACreateConnectionTicket(string url, string cosTicket, string httpUser, string httpPassword, string catalog)

Description

Creates a new OLAP connection using the XMLA protocol. This function is deprecated. Use XMLACreateNamedConnection() instead.

Supported Runtime Versions

4.0

This function is not supported in a cloud environment.


`Parameters`	`Description`
`url`	`URL of a server to connect to.`
`cosTicket`	`COS ticket to be used for authentication on the OLAP server.`
`httpUser`	`Additional user name to be used for HTTP authentication.`
`httpPassword`	`Additional password to be used for HTTP authentication.`
`catalog`	`The catalog to connect to.`

Return Value

A new XMLA connection object.

XMLACreateConnectionTicket

Declaration

XMLAConnection XMLACreateConnectionTicket(string url, string cosTicket, string catalog)

Description

Creates a new OLAP connection using the XMLA protocol. This function is deprecated. Use XMLACreateNamedConnection() instead.

Supported Runtime Versions

3.0, 4.0, 5.0

This function is not supported in a cloud environment.


`Parameters`	`Description`
`url`	`URL of a server to connect to.`
`cosTicket`	`Repository ticket.`
`catalog`	`The catalog to connect to.`

Return Value

A new XMLA connection object.

XMLACreateNamedConnection

Declaration

XMLAConnection XMLACreateNamedConnection(string dataConnectionName)

Description

Creates a new XMLA connection using a database connection string. It supports also Infor OLAP and External Infor OLAP data sources.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`dataConnectionName`	`Name of the data source.`

Return Value

A new OLAP connection.

XMLADisconnect

Declaration

void XMLADisconnect(XMLAConnection connection)

Description

Disconnects XMLA connection.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`connection`	`XMLA connection to disconnect.`

Return Value

Does not return a value.

XMLAExecuteMdxDouble

Declaration

XMLADoubleCellList XMLAExecuteMdxDouble(XMLAConnection connection, string mdx)

Description

Executes an MDX command that returns a double result set.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The XMLA connection to be used for executing the command.`
`mdx`	`The command to be executed.`

Return Value

The result of the MDX command.

XMLAExecuteMdxInt

Declaration

XMLAIntCellList XMLAExecuteMdxInt(XMLAConnection connection, string mdx)

Description

Executes an MDX command that returns an integer result set.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The XMLA connection to be used for executing the command.`
`mdx`	`The command to be executed.`

Return Value

The result of the MDX command.

XMLAExecuteMdxString

Declaration

XMLAStringCellList XMLAExecuteMdxString(XMLAConnection connection, string mdx)

Description

Executes an MDX command that returns a string result set.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The XMLA connection to be used for executing the command.`
`mdx`	`The command to be executed.`

Return Value

The result of the MDX command.

XMLAExecuteXml

Declaration

string XMLAExecuteXml(XMLAConnection connection, string xml)

Description

Executes an XML command.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`The XMLA connection to be used for executing the command.`
`xml`	`The command to be executed.`

Return Value

The result of the XML command.

XMLAGetCoordinates

Declaration

StringList XMLAGetCoordinates(XMLAStringCell cell)

Description

Returns the coordinates of a string cell.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`Cell to return coordinates of.`

Return Value

The coordinates of the cell.

XMLAGetCoordinates

Declaration

StringList XMLAGetCoordinates(XMLADoubleCell cell)

Description

Returns the coordinates of a double cell.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`Cell to return coordinates of.`

Return Value

The coordinates of the cell.

XMLAGetCoordinates

Declaration

StringList XMLAGetCoordinates(XMLAIntCell cell)

Description

Returns the coordinates of an int cell.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`Cell to return coordinates of.`

Return Value

The coordinates of the cell.

XMLAGetCubeList

Declaration

XMLACubeList XMLAGetCubeList(XMLAConnection connection)

Description

Returns the list of all cubes.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`connection`	`Connection to the server that returns all cubes.`

Return Value

A list of all cubes that belong to the connection.

XMLAGetCubeName

Declaration

string XMLAGetCubeName(XMLACube cube)

Description

Returns the name of the cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cube`	`Cube to return name of.`

Return Value

The name of the cube.

XMLAGetDimensionList

Declaration

XMLADimensionList XMLAGetDimensionList(XMLACube cube)

Description

Returns a list of the dimensions of a cube.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cube`	`The cube to return dimensions of.`

Return Value

A list of all dimensions that belong to the cube.

XMLAGetDimensionName

Declaration

string XMLAGetDimensionName(XMLADimension dimension)

Description

Returns the name of the dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`dimension`	`Dimension to return name of.`

Return Value

The name of the dimension.

XMLAGetHierarchyList

Declaration

XMLAHierarchyList XMLAGetHierarchyList(XMLADimension dimension)

Description

Returns a hierarchy list of the dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`dimension`	`The dimension to return the hierarchy list for.`

Return Value

The hierarchy list of the dimension.

XMLAGetHierarchyName

Declaration

string XMLAGetHierarchyName(XMLAHierarchy hierarchy)

Description

Returns the name of the dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`hierarchy`	`Dimension to return name of.`

Return Value

The name of the dimension.

XMLAGetMemberList

Declaration

XMLAMemberList XMLAGetMemberList(XMLAHierarchy hierarchy)

Description

Returns a member list of the hierarchy.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`hierarchy`	`Hierarchy to return members for.`

Return Value

The member list of the hierarchy.

XMLAGetMemberList

Declaration

XMLAMemberList XMLAGetMemberList(XMLAMember member)

Description

Returns a member list of a member.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`member`	`Member to return members for.`

Return Value

The member list of a member.

XMLAGetMemberName

Declaration

string XMLAGetMemberName(XMLAMember member)

Description

Returns the name of the dimension.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`member`	`Dimension to return name of.`

Return Value

The name of the dimension.

XMLAGetValue

Declaration

string XMLAGetValue(XMLAStringCell cell)

Description

Returns the value of a string cell.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`The cell to return the value of.`

Return Value

The value of the cell.

XMLAGetValue

Declaration

double XMLAGetValue(XMLADoubleCell cell)

Description

Returns the cell value of type double.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`The cell to return the value of.`

Return Value

The value of the cell.

XMLAGetValue

Declaration

int XMLAGetValue(XMLAIntCell cell)

Description

Returns the cell value of type int.

Supported Runtime Versions

3.0, 4.0, 5.0


`Parameters`	`Description`
`cell`	`The cell to return the value of.`

Return Value

The value of the cell.