WBS Essbase, Dodeca 8.3

Functions

AliasTableExists

Returns whether the specified alias table exists for the view's connection or the specified connection.

Since version 7.5

@AliasTableExists(<AliasTable>, [<ConnectionID>])
Argument Name Description

AliasTable

The alias table to attempt to resolve for the view's connection or the specified connection.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

CanConnect

Returns whether the specified Essbase connection can be connected to using the current crendentials or the specified credentials.

Since version 7.2

@CanConnect(<ConnectionID>, [<Username>], [<Password>])
Argument Name Description

ConnectionID

The ID of the Essbase connection.

Password

Optional. (The default is the current password associated with the Essbase connection.) The password to validate.

Username

Optional. (The default is the current username associated with the Essbase connection.) The username to validate.

DataPointDimGeneration

Returns the generation of the member for the specified dimension. 

@DPDimGen([<CellAddress>], <Dimension>)
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

Dimension

The dimension.

DataPointDimLevel

Returns the level of the member for the specified dimension. 

@DPDimLevel([<CellAddress>], <Dimension>)
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

Dimension

The dimension.

DataPointDimOrientation

Returns the orientation of the specified dimension. 

@DPDimOr([<CellAddress>], <Dimension>)
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

Dimension

The dimension.

DataPointDimValueAlias

Returns the alias for the specified dimension. 

@DPDimValAlias([<CellAddress>], <Dimension>, [<AliasTableName>])
Argument Name Description

AliasTableName

Optional (default is the alias table defined for the view). The name of the alias table to use.

CellAddress

Optional (default is the active cell). The address of the data-point cell.

Dimension

The dimension.

DataPointDimValueDisplayed

Returns the displayed member-name or alias for the specified dimension. 

@DPDimValDisp([<CellAddress>], <Dimension>)
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

Dimension

The dimension.

DataPointDimValueMember

Returns the member-name for the specified dimension. 

@DPDimValMbr([<CellAddress>], <Dimension>, [<AliasTableName>])
Argument Name Description

AliasTableName

Optional (default is the alias table defined for the view). The name of the alias table to use.

CellAddress

Optional (default is the active cell). The address of the data-point cell.

Dimension

The dimension.

DataPointDimValuesAliases

Returns a delimited list of dimension names and aliases for the specified cell. 

@DPDimValsAliases([<CellAddress>], [<AliasTableName>], [<ColumnDelimiter>], [<RowDelimiter>], [<Dimensions>])
Argument Name Description

AliasTableName

Optional (default is the alias table defined for the view). The name of the alias table to use.

CellAddress

Optional (default is the active cell). The address of the data-point cell.

ColumnDelimiter

Optional (default is =); The character to use between the dimension name and the dimension value.

Dimensions

Optional; A semicolon delimited list of dimensions to include in the list. By default, all dimensions are included.

RowDelimiter

Optional (default is ;); The character to use between each dimension.

DataPointDimValuesDisplayed

Returns a delimited list of dimension names and displayed values for the specified cell. 

@DPDimValsDisp([<CellAddress>], [<ColumnDelimiter>], [<RowDelimiter>], [<Dimensions>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

ColumnDelimiter

Optional (default is =); The character to use between the dimension name and the dimension value.

Dimensions

Optional; A semicolon delimited list of dimensions to include in the list. By default, all dimensions are included.

RowDelimiter

Optional (default is ;); The character to use between each dimension.

DataPointDimValuesMembers

Returns a delimited list of dimension names and member names for the specified cell. 

@DPDimValsMbrs([<CellAddress>], [<AliasTableName>], [<ColumnDelimiter>], [<RowDelimiter>], [<Dimensions>])
Argument Name Description

AliasTableName

Optional (default is the alias table defined for the view). The name of the alias table to use.

CellAddress

Optional (default is the active cell). The address of the data-point cell.

ColumnDelimiter

Optional (default is =); The character to use between the dimension name and the dimension value.

Dimensions

Optional; A semicolon delimited list of dimensions to include in the list. By default, all dimensions are included.

RowDelimiter

Optional (default is ;); The character to use between each dimension.

DataPointHasCellNote

Returns true or false based on whether the specified cell has cell note(s) associated with it. 

@DPHasCellNote([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointHasLinkedObjects

Returns true or false based on whether the specified cell has linked objects associated with it. 

@DPHasLinkedObjects([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsBlank

Returns true or false based on whether the specified cell is blank. 

@DPIsBlank([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsDouble

Returns true or false based on whether the specified datapoint cell contains a double value. 

@DPIsDouble([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsError

Returns true or false based on whether the specified datapoint cell contains an error value. 

@DPIsError([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsMissing

Returns true or false based on whether the specified datapoint is missing. 

@DPIsMissing([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsNoAccess

Returns true or false based on whether the specified datapoint is NoAccess. 

@DPIsNoAccess([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsReadOnly

Returns true or false based on whether the specified datapoint cell is ReadOnly. 

@DPIsReadOnly([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsReadWrite

Returns true or false based on whether the specified datapoint cell is ReadWrite. 

@DPIsReadWrite([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DataPointIsZero

Returns true or false based on whether the specified datapoint cell contains a value or zero. 

@DPIsZero([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the data-point cell.

DimensionUDAs

Returns a semicolon delimited list of UDA's for the specified dimension.

Since version 7.5

@DimUDAs(<DimensionName>, [<ConnectionID>], [<DefaultValue>], [<Matching>], [<UseCache>])
Argument Name Description

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

DimensionName

The dimension specified.

Matching

Optional (default is match all); Filter for UDAs that match the specified wildcard string (case insensitive).

UseCache

Optional (default is true); Indicates whether the UDAs should be returned from the session cache, if contained in the cache, or retrieved from the database.

EssConnectionPropertyValue

Returns the value of the specified EssbaseConnection property. 

@EssConnPVal(<ConnectionID>, <PropertyName>)
Argument Name Description

ConnectionID

The ID of the Essbase connection.

PropertyName

The name of the EssbaseConnection property. Property names include: Application DoEssbasePerformanceLogging ExtendedCubeInfoEnabled ClusterName DoRequestResponseLogging NotifyOnStatefulClusterNodeFailure Database EssDomain.AdminUsername Server DataSource EssDomain.APSUrl Stateless EssDomain.ServletPath EssDomain.Username

EssbaseCalcScript

Returns the specified calc script from the server. 

@EssCalcScript(<CalcScriptName>, [<ConnectionID>])
Argument Name Description

CalcScriptName

The name of the calc script on the server.

ConnectionID

The ID of the Essbase connection. If no ID specified and the view is an Essbase view, the connection associated with the view is used.

EssbaseDatabaseNote

Returns the database note attached to an Essbase cube. 

@EssDatabaseNote([<ConnectionID>])
Argument Name Description

ConnectionID

The ID of the Essbase connection. If no ID specified and the view is an Essbase view, the connection associated with the view is used.

IsConnected

Returns whether the specified Essbase connection is connected.

Since version 7.2

@IsConnected(<ConnectionID>)
Argument Name Description

ConnectionID

The ID of the Essbase connection.

IsDataCell

Returns true or false based on whether the specified cell is an Essbase datapoint cell. 

@IsDataCell(<CellAddress>)
Argument Name Description

CellAddress

The address of the data-point cell.

IsDrillthroughSheet

Returns a boolean indicating whether the active sheet is a drill-through sheet. 

@IsDrillThroughSheet()

IsMember

Returns whether the specified member exists.

Since version 7.7

@IsMember(<MemberName>, [<AliasTable>], [<ConnectionID>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

MemberName

The member specified can be an alias or a member name.

IsMemberCell

Returns true or false based on whether the specified cell is an Essbase member cell. 

@IsMemberCell(<CellAddress>)
Argument Name Description

CellAddress

The address of the data-point cell.

MemberAlias

Returns the Essbase Alias of the specified member. 

@MbrAlias(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to get the alias from.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if no alias is found.

MemberName

The member specified can be an alias or a member name.

MemberAttributeValue

Returns the value of the specified member attribute.

Since version 7.7

@MbrAttrVal(<MemberName>, <Attribute>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

Attribute

The attribute.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberCellDimensionName

Returns the dimension name of the specified member cell. If the cell is not a member cell, returns an empty string "". 

@MemberCellDimensionName([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellDimensionNumber

Returns the dimension number of the specified member cell. If the cell is not a member cell, returns 0. 

@MemberCellDimensionNumber([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsDimension

Returns true or false based on whether the specified member cell is the dimension member. 

@MemberCellIsDimension([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsExplicitlyShared

Returns true or false based on whether the specified member cell is an explicit share. 

@MemberCellIsExplicitlyShared([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsImplicitlyShared

Returns true or false based on whether the specified member cell is an implicit share. 

@MemberCellIsImplicitlyShared([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsLabelOnly

Returns true or false based on whether the specified member cell is label only. 

@MemberCellIsLabelOnly([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsNeverShare

Returns true or false based on whether the specified member cell is marked as never share. 

@MemberCellIsNeverShare([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsParent

Returns true or false based on whether the specified member cell is a parent member. 

@MemberCellIsParent([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberCellIsStoredData

Returns true or false based on whether the specified member cell is a stored data member. 

@MemberCellIsStoredData([<CellAddress>])
Argument Name Description

CellAddress

Optional (default is the active cell). The address of the member cell.

MemberChildCount

Returns the number of children of the specified member. 

@MbrChildCnt(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is -1); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberDimension

Returns the DimensionName of the specified member. 

@MbrDim(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberFirstChild

Returns the name of the first child of the specified member. 

@MbrFirstChild(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberFormula

Returns the formula of the specified member.

Since version 7.7

@MbrFormula(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberGeneration

Returns the Essbase Generation of the specified member. 

@MbrGeneration(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is -1); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberHasUDA

Returns TRUE if the specified member has the specified UDA. 

@MbrHasUDA(<MemberName>, <UDA>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is false); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

UDA

The UDA.

MemberKey

Returns the Key of the specified member. 

@MbrKey(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberLevel

Returns the Essbase Level of the specified member. 

@MbrLevel(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is -1); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberName

Returns the Essbase Name of the specified member. 

@MbrName(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberNextSibling

Returns the name of the next sibling of the specified member. 

@MbrNextSib(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberParentKey

Returns the Key of the specified member. 

@MbrPKey(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberPreviousSibling

Returns the name of the previous sibling of the specified member. 

@MbrPrevSib(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

MemberRelatedMembers

Returns a delimited list of members that are related to the specified member. 

@MbrRelatedMbrs(<MemberName>, <Relationship>, [<Delimiter>], [<MemberFormat>], [<EscapeSingleQuotes>], [<ReturnAliases>], [<AliasTable>], [<ConnectionID>], [<DefaultValue>])
Argument Name Description

AliasTable

Optional (default is the view's alias table); If ReturnAliases is true, the name of the alias table.

ConnectionID

Optional (default is the view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if no related members found.

Delimiter

Optional (default is a semi-colon); The character to use between each related member. To specify a comma, enclose the comma in double quotes ",".

EscapeSingleQuotes

Optional (default is false); Controls whether a single quotation mark within a member name or alias is automatically escaped with another single quote. This setting is intended for use when the evaluated function value is to be used within a relational query.

MemberFormat

Optional (default is no formatting); Allows each member to be prepended and/or appended with specified text. The format must contain the format item {0}, which is replaced with the member string. For example, to enclose each member string in single quotes, the value should be set to '{0}'.

MemberName

The member specified can be an alias or a member name.

Relationship

Relationship to specified member to determine related members: membmChildren, Descendants, BottomLevel, Siblings, SameLevel, SameGen, Parent, Ancestors

ReturnAliases

Optional (default is false); Indicates whether aliases are returned instead of member names.

MemberUDAs

Returns a semicolon delimited list of UDA's for the specified member. 

@MbrUDAs(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>], [<UseCache>])
Argument Name Description

AliasTable

Optional (default is the view's AliasTable); The alias table to use.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

DefaultValue

Optional (default is an empty string); The value to use if not found.

MemberName

The member specified can be an alias or a member name.

UseCache

Optional (default is true); Indicates whether the UDAs should be returned from the session cache, if contained in the cache, or retrieved from the database.

ResolveAliasTable

Returns the specified alias table, the view's default alias table, or the default alias table if the specified table does not exist.

Since version 7.5

@ResolveAliasTable(<AliasTable>, [<ConnectionID>], [<PreferViewDefault>])
Argument Name Description

AliasTable

The alias table to attempt to resolve for the view's connection or the specified connection.

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

PreferViewDefault

Optional (defaults to true); Whether to attempt to prefer the view's default alias table.

SelectorMemberAlias

Returns the alias(es) of the selected members for the specified Essbase selector. 

@SMbrAlias(<SelectorID>, [<Delimiter>])
Argument Name Description

Delimiter

Optional (default is ;); The delimiter to use when there are multiple selections.

SelectorID

The ID of the selector.

SelectorMemberName

Returns the name(s) of the selected members for the specified Essbase selector. 

@SMbrName(<SelectorID>, [<Delimiter>])
Argument Name Description

Delimiter

Optional (default is ;); The delimiter to use when there are multiple selections.

SelectorID

The ID of the selector.

SubstitutionVariable

Returns the value of the specified Essbase SubstitutionVariable. 

@SubstVar(<SubstitutionVariableName>, [<connection-ID>], [<scope>])
Argument Name Description

ConnectionID

Optional (defaults to view's connection); The ID of the Essbase connection.

Scope

Optional (defaults to Any, which checks the cube, application, and server, and returns the most locally scoped variable); The scope of the substitution variable to return. Valid values include: Any, Server, Application, and Cube.

SubstitutionVariableName

The name if the substitution variable to query for.