OLAP functions

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return Value

Does not return a value.

OLAPCreateAttributeTableFields

Declaration

void OLAPCreateAttributeTableFields(OLAPConnection connection, string dimension, int tableIndex, StringList attributeNames, StringList attributeTypes, StringList attributeDescriptions)

Description

Creates dimension attribute fields.

Supported Runtime Versions

4.0, 5.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return Value

A new data area definition.

OLAPCreateDataAreaExportMultipleValue

Declaration

OLAPDataAreaExportConfiguration OLAPCreateDataAreaExportMultipleValue(string dataConnection, string targetTable, string valueDimension)

Description

Used to configure data area export when using multiple value columns.

Supported Runtime Versions

5.0

Return Value

Instance of data area export configuration.

OLAPCreateDataAreaExportSingleValue

Declaration

OLAPDataAreaExportConfiguration OLAPCreateDataAreaExportSingleValue(string dataConnection, string targetTable, string valueColumn)

Description

Used to configure data area export when using a single value column.

Supported Runtime Versions

5.0

Return Value

Instance of data area export configuration.

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

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

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

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

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

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

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

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

Return Value

Does not return a value.

OLAPCreateEditDimensionRequest

Declaration

OLAPEditDimensionRequest OLAPCreateEditDimensionRequest(string dimensionName)

Description

Creates a new OLAPEditDimensionRequest instance. The request can be sent 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

Return Value

A new OLAPEditDimensionRequest instance.

OLAPCreateEditDimensionRequest

Declaration

OLAPEditDimensionRequest OLAPCreateEditDimensionRequest(string dimensionName, string hierarchyName)

Description

Creates a new OLAPEditDimensionRequest instance. The request can be sent 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

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

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

Return Value

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

OLAPCreateHierarchyExport

Declaration

OLAPHierarchyExportConfiguration OLAPCreateHierarchyExport(string dataConnection, string targetTable, string nameColumn, string typeColumn, string orderColumn)

Description

Defines configuration settings for hierarchy export.

Supported Runtime Versions

5.0

Return Value

Instance of data area export configuration.

OLAPCreateNamedConnection

Declaration

OLAPConnection OLAPCreateNamedConnection(string dataConnectionName)

Description

Creates a new OLAP connection using a data connection.

Supported Runtime Versions

5.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return Value

Does not return a value.

OLAPCreateSubsetDefinition

Declaration

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

Description

Creates a subset definition.

Supported Runtime Versions

5.0

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

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

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

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

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

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

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

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

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

Return Value

True, if the cube exists, false otherwise.

OLAPDataAreaExportAddColumnMapping

Declaration

void OLAPDataAreaExportAddColumnMapping(OLAPDataAreaExportConfiguration configuration, string dimensionName, string elementTargetColumn)

Description

Maps a dimension to a column in the target table.

Supported Runtime Versions

5.0

Return Value

Does not return a value.

OLAPDataAreaExportAddColumnMapping

Declaration

void OLAPDataAreaExportAddColumnMapping(OLAPDataAreaExportConfiguration configuration, string dimensionName, string hierarchyTargetColumn, string elementTargetColumn)

Description

Maps a dimension to a column in the target table and stores the hierarchy’s name in a separate column.

Supported Runtime Versions

5.0

Return Value

Does not return a value.

OLAPDataAreaExportAddValueMapping

Declaration

void OLAPDataAreaExportAddValueMapping(OLAPDataAreaExportConfiguration configuration, string elementName, string targetColumn)

Description

Maps a value (measure element) to a target column to export it to a table with multiple value columns (each measure in a separate column). Throws an exception when adding mapping to a configuration for single-value export.

Supported Runtime Versions

5.0

Return Value

Does not return a value.

OLAPDeleteAttributeTable

Declaration

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

Description

Deletes an attribute table.

Supported Runtime Versions

3.0, 4.0, 5.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 error.

Supported Runtime Versions

5.0

Return Value

Does not return a value.

OLAPExportDataArea

Declaration

void OLAPExportDataArea(OLAPDataArea dataArea, OLAPDataAreaExportConfiguration configuration)

Description

Exports a data area to a relational table, defined by the export configuration.

Supported Runtime Versions

5.0

Return Value

Does not return a value.

OLAPExportHierarchy

Declaration

void OLAPExportHierarchy(OLAPDimension dimension, string hierarchyName, OLAPHierarchyExportConfiguration configuration)

Description

Exports a dimension's hierarchy to a relational table based on the export configuration settings.

Supported Runtime Versions

5.0

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

Return Value

Does not return a value.

OLAPGetApplicationName

Declaration

string OLAPGetApplicationName(OLAPConnection connection)

Description

Returns the name of the application that owns the OLAP model.

Supported Runtime Versions

5.0