WBS Essbase, Dodeca 8.3

EssbaseAncestorsOfMember

Add information about a list of Essbase members, determined by whether they are ancestors of a specified member, to a DataCache.

EssbaseDynamicTimeSeriesMembers

Add information about Essbase dynamic-time-series members to a DataCache.

EssbaseMDXScript

Add the results of an Essbase MDX script to a DataCache.

EssbaseMemberQuery

Add the results of an Essbase member query to a DataCache.

EssbaseMembersFromMemberQueries

Add the results of multiple Essbase member-queries to a DataCache.

EssbaseMembersFromReport

Add information about a list of Essbase members, generated from an Essbase report script, to a DataCache.

EssbaseMembersPerGeneration

Add information about Essbase members of a specified generation to a DataCache.

EssbaseMembersPerLevel

Add information about Essbase members of a specified level to a DataCache.

EssbaseMembersPerRelationship

Add information about a list of Essbase members, determined by their relationship to a specified member, to a DataCache.

EssbaseMembersPerSearch

Add information about a list of Essbase members, determined by a search of the outline, to a DataCache.

EssbaseMembersPerUDA

Add information about a list of Essbase members, determined by whether they have a specified UDA, to a DataCache.

EssbaseMembersSpecified

Add information about a specified list of Essbase members to a DataCache.

EssbaseReportScript

Add the results of an Essbase report script to a DataCache.

SQLPassthroughDataSet

Build a DataCache from a Dodeca SQLPassthroughDataSet.

SQLScript

Add the results of a SQL query to a DataCache.

URL

Build a DataCache from the values returned in XML format from a URL. Specify the URL in the ScriptText argument. The list values will be taken from any nodes named "value" like Single-column: <root><value>Value 1</value><value>Value 2</value><value>Value 3</value></root> Multi-column: <root><value><value>Value 1</value><value>Value 2</value><value>Value 3</value></value><value><value>Value 1</value><value>Value 2</value><value>Value 3</value></value></root>

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

BaseMember

Member used as the root of the search. Typically, this will be a dimension, but may be any member in the hierarchy.

Descendant

Member name or alias for which to search (including wildcards).

AliasTableName

The Alias table from which alias names are returned.

ReturnType

Specifies what information is retrieved for each member.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

AliasTableName

The Alias table from which alias names are returned.

ReturnType

Specifies what information is retrieved for each member.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

IdentifierType

Controls whether member names, aliases, or unique names are returned by the query. The UniqueNames option is applicable when the outline contains duplicate member names. By default, IdentifierType is Name; Member names are returned.

AliasTableName

The Alias table from which alias names are returned.

ScriptText

The text of the script that will be run.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

Queries

Query strings used to retrieve member information.

AliasTableName

The Alias table from which alias names are returned.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.

AliasTableName

The Alias table from which alias names are returned.

ReturnType

Specifies what information is retrieved for each member.

MaxReturnCount

Override default maximum of 64000.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

Dimension

Dimension to search.

GenerationName

Generation name from which to collect members.

GenerationNumber

Generation number from which to collect members.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

Dimension

Dimension to search.

LevelName

Level name from which to collect members.

LevelNumber

Level number from which to collect members.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

BaseMember

Member used as the root of the search. Typically, this will be a dimension, but may be any member in the hierarchy.

Relationship

Relationship to base member to determine related members.

SearchDimension

Dimension to search - if restricting to a single dimension.

ReturnType

Specifies what information is retrieved for each member.

IncludeMember

Flag indicating whether to include the base member in the returned array.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

SearchString

Member name to search for. [ex: "new*" will find "new york", "new hampshire", and "new mexico"]

SearchScope

Indicates whether member and/or alias names are searched.

SearchDimension

Dimension to search - if restricting to a single dimension.

SearchAliasTable

If scope includes alias names, alias table to search.

ReturnType

Specifies what information is retrieved for each member.

ReturnAliasTable

Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

Dimension

Dimension to search.

UDA

Finds members with this user-defined attribute.

UDAValue

Finds members with this value assigned to the user-defined attribute.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

Members

Member names used as search criteria, delimited by semicolon.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.

ScriptText

The text of the script that will be run.

Username

The username to use.

Password

The password to use.

ServletPath

The servlet-path to use.

Driver

The driver to use.

SQLConnectString

The SQL connect-string to use.

ScriptText

The text of the script that will be run.

General

Add a token for one or more Essbase substitution variables.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

MatchType

Specify how to match the value entered for SubstitutionVariable.

SubstitutionVariable

The substitution variable name, or a regular expression, depending on the value of MatchType.

Scope

Specifies the scope of the substitution variables for which tokens are added. The default scope is Any, which queries for the most locally scoped variables.

TokenName

The name of the token to create, like [T.Product]. If TokenName contains "<VarName>", like "[T.<VarName>]" then it will be replaced with the name of the substitution variable.

TokenType

Specify whether to create an application or view token.

SyncTokens

Whether to sync the token table after adding the tokens. If not specified TRUE will be used.

CartesianList

Build a range on the sheet based on the cartesian product of values from two or more delimited string lists.

DataCache

Build a range on the sheet based on a DataCache created using the AddDataCache method.

DelimitedString

Loop a list of values specified by a delimited string.

EssbaseMdxQuery

Build a range on the sheet from the results of an Essbase MDX query.

EssbaseMemberQuery

Build a range on the sheet from an Essbase member query.

EssbaseReportScript

Build a range on the sheet from an Essbase report script.

SQLPassthroughDataSet

Build a range on the sheet from a Dodeca SQLPassthroughDataSet.

SQLScript

Build a range on the sheet from the results of a SQL query.

URL

Loop values returned in XML format from a URL. Nodes named "value" will be used in the loop.

ScriptText

The text of the script that will be run.

ListDelimiter

The delimiter to use to define the end of each List.

Delimiter

The delimiter to use to define the end of each value.

StartCell

The address of the cell that the first row of script output goes into.

ScriptResultColumnCount

The number of columns that will be in each row of the script result.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

SortOrder

Specifies one or more columns of the DataCache to sort by.

Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC"

StartCell

The address of the cell that the first row of script output goes into.

ScriptResultColumnCount

The number of columns that will be in each row of the script result.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

ScriptText

The text of the script that will be run.

Delimiter

The delimiter to use to define the end of each value.

StartCell

The address of the cell that the first row of script output goes into.

ScriptResultColumnCount

The number of columns that will be in each row of the script result.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

Dataless

Controls whether the MDX query returns data values along with the members, or members only. By default, Dataless is FALSE; Data values are returned.

HideRestrictedData

Controls whether data to which the user has no access is suppressed. By default, HideRestrictedData is TRUE; Restricted data is not returned.

IdentifierType

Controls whether member names, aliases, or unique names are returned by the query. The UniqueNames option is applicable when the outline contains duplicate member names. By default, IdentifierType is Name; Member names are returned.

AliasTableName

The name of the alias table from which aliases are obtained.

RepeatRowMemberLabels

Controls whether member names are repeated for each row returned by the query. By default, RepeatMemberLabels is True.

StartCell

The address of the cell that the first row of script output goes into.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

StartCell

The address of the cell that the first row of script output goes into.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

StartCell

The address of the cell that the first row of script output goes into.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

StartCell

The address of the cell that the first row of script output goes into.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

ScriptText

The text of the script that will be run.

Username

The username to use.

Password

The password to use.

ServletPath

The servlet-path to use.

Driver

The driver to use.

SQLConnectString

The SQL connect-string to use.

StartCell

The address of the cell that the first row of script output goes into.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

ScriptText

The text of the script that will be run.

StartCell

The address of the cell that the first row of script output goes into.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

General

Connect an Essbase connection.

ConnectionID

The ID of the Essbase Connection to use for the connection.

EssbaseLoginServiceObjectTypeID

The name of the IEssbaseLoginService to use to prompt for Essbase credentials. If blank, EssbaseLoginServiceObjectTypeID associated with the view will be used.

General

Executes a custom Java service on the dodeca-essbase server using the specified arguments.

ServiceName

The name of the custom service to execute on the dodeca-essbase server. The value must correspond to a custom entry in the dodeca-essbase service's WEB-INF\classes\dodeca-essbase-actions.properties file, which maps the service name to the fully qualified Java class name that implements the service.

FunctionArgumentsXml

The XML containing the arguments to pass to the service.

IncludeConnectionXml

Indicates whether the Essbase connection information is included in the Xml passed to the service. If TRUE, the Java class must subclass from EssOperation or one of its subclasses. The EssConnectionManager is automatically instanced and available to the subclass in a protected method overload.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by the service. The ConnectionID is only used when IncludeConnectionXml is True. For an Essbase view, the ConnectionID is optional. If not specified, the view's EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

IncludeGridXml

Indicates whether the grid data is included in the Xml passed to the service. If TRUE, the Java class must subclass from EssGridOperation. The EssConnectionManager is automatically instanced and available to the subclass in a protected method overload. The EssConnectionManager.getGridView() method also returns an IEssGridView object filled with the grid data passed to the server. By default, the IEssGridView does not contain numbers passed from client. To fill the grid with numeric cells sent from the client, override the protected EssGridOperation.isUpdate() method as follows:

ResultPropertyName

(Optional) The name of the workbook script property that receives the value of the result returned by the function. If the property data type is Boolean, the workbook script will attempt to convert the value to True or False; otherwise, the value is treated as a string. If the property does not exist, it is created.

ResultsDataCacheName

(Optional) The name of the DataCache that the result values can be written to when the result string represents tabular data where rows are newline delimited and columns are tab delimited. The first column value of each row is used as the row index.

ResultsDataCacheUseFirstColumnAsKey

When the ResultsDataCacheName is specified, the argument indicates whether the first column value of each result row is used as the key for the corresponding data cache row. By default, the argument value is TRUE. The argument value can be set to FALSE when there is no need to lookup a row within the data cache or when the first column potentially contains duplicate values.

BackgroundExecute

Controls whether the function is executed asynchronous.

Timeout

The numbers of seconds allowed to elapse before the execution of the function is timed out on the server. The default value of 0 indicates that no timeout is enforced.

CoverDuringExecute

Controls whether the view is covered while the custom function is executing.

ProgressTextServiceStarted

(Optional) The text string displayed as the progress text in the status bar before the service is started. If no value is specified, "Custom service started" is displayed as the progress text.

ProgressTextServiceCompleted

(Optional) The text string displayed as the progress text in the status bar after the service completes. If no value is specified, "Custom service completed" is displayed as the progress text.

General

Disconnect an Essbase connection.

ConnectionID

The ID of the Essbase Connection to disconnect.

General

Do an Essbase KeepOnly.

SelectedRange

The range to select while doing the Essbase KeepOnly.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

GridData

Execute an Essbase MDX query that is defined by the MDX argument and write the result to a worksheet.

MDXScriptID

The ID of the Essbase Script that represents the MDX query to run.

MDX

The text of the MDX query to execute.

Axis

Controls which of the axes of data generated by the query is returned to the client. By default, Axis is RowsColumnsAndPages; The data for the Rows, Columns, and Pages axes is returned to the client.

Dataless

Controls whether the MDX query returns data values along with the members, or members only. By default, Dataless is FALSE; Data values are returned.

HideRestrictedData

Controls whether data to which the user has no access is suppressed. By default, HideRestrictedData is TRUE; Restricted data is not returned.

IdentifierType

Controls whether member names, aliases, or unique names are returned by the query. The UniqueNames option is applicable when the outline contains duplicate member names. By default, IdentifierType is Name; Member names are returned.

AliasTableName

The name of the alias table from which aliases are obtained.

RepeatRowMemberLabels

Controls whether member names are repeated for each row returned by the query. By default, RepeatRowMemberLabels is True.

ConnectionID

The ID of the Essbase Connection to use for the query.

Username

The username of the Essbase credentials used to execute the query. If the username and password are not specified, the default credentials are used.

Password

The password of the Essbase credentials used to execute the query. If the username and password are not specified, the default credentials are used.

StartCell

The address of the cell where the first row and column of the report output goes.

OutputRangeName

The defined name to create for the range that contains the report output.

ProgressTextQueryStarted

(Optional) The text string displayed as the progress text in the status bar before the query is started. If no value is specified, "MDX query started" is displayed as the progress text.

ProgressTextQueryCompleted

(Optional) The text string displayed as the progress text in the status bar after the query completes. If no value is specified, "MDX query completed" is displayed as the progress text.

ProgressTextQueryFailed

(Optional) The text string displayed as the progress text in the status bar if the query fails. If no value is specified, "MDX query failed" is displayed as the progress text.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

General

Do an Essbase Pivot.

FromCell

The address of the cell that contains the member that the pivot is being done on.

ToCell

The address of the cell to pivot the from cell to.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

General

Do an Essbase RemoveOnly.

SelectedRange

The range to select while doing the Essbase RemoveOnly.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ServerBased

Run an Essbase report that is defined on the server and write the output to a worksheet.

TextBased

Run an Essbase report that is defined by the ReportSpec argument and write the output to a worksheet.

ReportScript

The name (server-side) of the report script to run.

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

StartCell

The address of the cell used as the location of the first row and column of the query results.

OutputRangeName

The defined name to create for the range that contains the query results.

ConnectionID

The ID of the Essbase Connection to use for the report.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

AttributesPolicy

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client. When specified, the AttributesPolicy argument takes precedence over the deprecated Attributes argument. When the AttributesPolicy argument is not specified and the Attributes argument is specified, the Attributes argument is used, but the value is reversed as was the behavior prior to the deprecation of the Attributes argument. When neither argument is specified, attributes are returned. WARNING: Attributes should not be included if the report script suppresses page and column headings using {SUPPAGEHEADING} and {SUPCOLHEADING}.

IncludeAttributes

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ReportScriptID

The ID of the Essbase Script that represents the report script to run.

ReportSpec

The text of the report script to run.

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

StartCell

The address of the cell used as the location of the first row and column of the query results.

OutputRangeName

The defined name to create for the range that contains the query results.

ConnectionID

The ID of the Essbase Connection to use for the report.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

AttributesPolicy

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client. When specified, the AttributesPolicy argument takes precedence over the deprecated Attributes argument. When the AttributesPolicy argument is not specified and the Attributes argument is specified, the Attributes argument is used, but the value is reversed as was the behavior prior to the deprecation of the Attributes argument. When neither argument is specified, attributes are returned. WARNING: Attributes should not be included if the report script suppresses page and column headings using {SUPPAGEHEADING} and {SUPCOLHEADING}.

IncludeAttributes

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

Adhoc

Performs an Essbase retrieve operation for an Ad-hoc Essbase view.

General

Performs an Essbase retrieve operation for an Excel Essbase view.

Range

Performs an Essbase retrieve operation on a specific range for an Excel Essbase view.

EssbaseConnectionID

The Essbase connection ID.

ReplaceTokens

Whether to do token replacement before the retrieve.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

AutoAddRetrieveSubRanges

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only. The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange. For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1. The named ranges can be used by the view's workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed. If left blank the View's setting for AutoAddRetrieveSubRanges will be used.

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

RetrievePolicy

Indicates whether only the active sheet, or all sheets, or all retrieve ranges should be retrieved when performing an Essbase retrieve operation.

ReplaceTokens

Whether to do token replacement before the retrieve.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

AutoAddRetrieveSubRanges

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only. The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange. For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1. The named ranges can be used by the view's workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed. If left blank the View's setting for AutoAddRetrieveSubRanges will be used.

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

RangeName

The range to do the Essbase retrieve on.

EssbaseConnectionID

The Essbase connection ID.

ReplaceTokens

Whether to do token replacement before the retrieve.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

AutoAddRetrieveSubRanges

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only. The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange. For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1. The named ranges can be used by the view's workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed. If left blank the View's setting for AutoAddRetrieveSubRanges will be used.

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

DefaultCalc

Run the cube's default Calc.

General

Run an Essbase Calc.

ServerBased

Run Essbase Calc that is defined on the server.

TextBased

Run an Essbase Calc defined by the ScriptText argument.

BackgroundCalc

Whether the method is executed asynchronous.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

ScriptName

The name (server-side) of the script to run.

CalcScriptID

The ID of the Essbase Script that represents the calc script to run.

ScriptText

The text of the script to run.

BackgroundCalc

Whether the method is executed asynchronous.

AddLineIndex

The line number of the calc script to add a line at. Leave this argument empty to add at the end of the script.

AddLineText

A line of calc script text to add to the calc script.

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

ScriptName

The name (server-side) of the script to run.

RuntimeSubVars

(Optional) The runtime substitution variables that are used in a calculation script. The variables are specified as a delimited string of substitution variables and member pairs, such as currMarket="Florida";currScenario="Actual";

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

BackgroundCalc

Whether the method is executed asynchronous.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

CalcScriptID

The ID of the Essbase Script that represents the calc script to run.

ScriptText

The text of the script to run.

RuntimeSubVars

(Optional) The runtime substitution variables that are used in a calculation script. The variables are specified as a delimited string of substitution variables and member pairs, such as currMarket="Florida";currScenario="Actual";

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

BackgroundCalc

Whether the method is executed asynchronous.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

General

Run a MaxL script.

ScriptText

One of more MaxL statements to be run.

ContinueOnError

Controls whether script execution continues after an error is encountered.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view's EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

MessagesSheetName

If not blank, a worksheet will be added to the current view with the messages produced by the MaxL script execution.

ResultsSheetName

If not blank, a worksheet will be added to the current view with the results of each MaxL statement in the script. If the script contains more than one statement then a sequentially numbered sheet will be added for each statement.

StatementMessagesSheetName

If not blank, a worksheet will be added to the current view with the messages of each MaxL statement in the script. If the script contains more than one statement then a sequentially numbered sheet will be added for each statement.

MessagesDataCacheName

If not blank, a DataCache will be added to the current view with the messages produced by the MaxL script execution.

ResultsDataCacheName

If not blank, a DataCache will be added to the current view with the results of the MaxL script. If the script contains more than one statement then a sequentially numbered DataCache will be added for each statement.

StatementMessagesDataCacheName

If not blank, a DataCache will be added to the current view with the messages returned by each statement in the MaxL script. If the script contains more than one statement then a sequentially numbered DataCache will be added for each statement.

DataCacheColumnLabels

Whether to include column headers for DataCaches. The default is FALSE.

BackgroundExecute

Controls whether the method is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the script is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the script is run. If no value is specified, "Running MaxL" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the script is completed. If no value is specified, "RunMaxL completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the script fails. If no value is specified, "RunMaxL failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the MaxL script fails to run.

LogFileName

Specify a filename for the log file. If LogFileName is left blank no log file will be created.

LogFileFolder

Specify the full path to the folder of the log file. If LogFileFolder is left blank the log file will be written to the Desktop folder. If LogFileName is left blank no log file will be created.

LogFileOverwritePolicy

Specify what to do if the specified log file already exists. If LogFileOverwritePolicy is left blank IncrementFileName will be used. Append: Append new results to the existing file. IncrementFileName: Create a new file with a sequential number appended to the filename, like "MyLogFileName (1).txt". Overwrite: Replace the existing file with the new file.

FileBased

Run a script on the server using the specified CommandLine.

TextBased

Run a script, specified as the ScriptText argument, on the server using the specified CommandLine.

ScriptTimeout

The numbers of seconds allowed to elapse before the script is timed out. The default value of 0 indicates that no timeout is enforced.

Filename

The name of the file to execute on the server using the CommandLine. For the TextBased overload, if not specified, a unique file name is generated.

Folder

The full path of the folder that contains the Filename.

CommandLine

The command line to execute on the server, which can optionally contain placeholders for the following parameters, which are replaced with the actual value at runtime: %directory% - The absolute path of the specified Folder, %filename% -- The absolute path of the specified Filename, %file.separator% - The file separator used by the server operating system, and the following Essbase connection parameters: %server%, %application%, %database%, %username%, %password%.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view's EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

BackgroundExecute

Controls whether the method is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the script is running.

ResultPropertyName

The name of the workbook script property that receives the value of the script execution result returned from the server. The value is either True, which indicates success, or False, which indicates an error occurred.

DetailsPropertyName

The name of the workbook script property that receives the value of the script execution details returned from the server. If the result is True, the details represent the value returned by the script to stdout. If the result if False, the details represent the value returned by the script to stderr.

ScriptTimeout

The numbers of seconds allowed to elapse before the script is timed out. The default value of 0 indicates that no timeout is enforced.

ScriptText

The text of the script to run on the server. The ScriptText is written to a file and the file is executed using the CommandLine.

CommandLine

The command line to execute on the server, which can optionally contain placeholders for the following parameters, which are replaced with the actual value at runtime: %directory% - The absolute path of the specified Folder, %filename% -- The absolute path of the specified Filename, %file.separator% - The file separator used by the server operating system, and the following Essbase connection parameters: %server%, %application%, %database%, %username%, %password%.

Filename

The name of the file to execute on the server using the CommandLine. For the TextBased overload, if not specified, a unique file name is generated.

Folder

The full path of the folder that contains the Filename.

Extension

The extension appended to the file created on the server.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view's EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

BackgroundExecute

Controls whether the method is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the script is running.

ResultPropertyName

The name of the workbook script property that receives the value of the script execution result returned from the server. The value is either True, which indicates success, or False, which indicates an error occurred.

DetailsPropertyName

The name of the workbook script property that receives the value of the script execution details returned from the server. If the result is True, the details represent the value returned by the script to stdout. If the result if False, the details represent the value returned by the script to stderr.

Adhoc

Performs an Essbase send operation for an Ad-hoc Essbase view.

General

Performs an Essbase send operation for an Excel Essbase view.

Range

Performs an Essbase send operation on a specific range for an Excel Essbase view.

EssbaseConnectionID

The Essbase connection ID.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

UseMemberNamesAndAliasesForRows

Controls whether to use member names and aliases for the row dimension. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

SendPolicy

Indicates whether only the active sheet, or all sheets, or all retrieve ranges should be sent when performing an Essbase send operation.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

UseMemberNamesAndAliasesForRows

Controls whether to use member names and aliases for the row dimension. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

RangeName

The range to do the Essbase Send on.

EssbaseConnectionID

The Essbase connection ID.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

UseMemberNamesAndAliasesForRows

Controls whether to use member names and aliases for the row dimension. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseUniversalRange

Set the Essbase universal range's Essbase options. User's settings, if allowed, will override these settings.

General

Set the view's Essbase options. User's settings, if allowed, will override these settings.

UniversalRangeName

The name of the Essbase universal range to which the options are applied.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

LatestMemberName

Indicates the name of the member to use as the latest time period for dynamic time series retrievals.

SpecifyLatestMember

Controls whether the LatestMemberName is used by dynamic time series retrievals.

MemberRetentionIncludeSelection

Controls whether the selected member is retained along with the other members retrieved by a Zoom In operation.

MemberRetentionRemoveUnselectedGroups

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation removes all dimension groups that are not in the selected group.

MemberRetentionWithinSelectedGroup

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation is applied only to the dimension of the selected member(s). WithinSelectedGroup is only applicable when the sheet contains two or more dimensions of data down a sheet as rows or across a sheet as columns.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ZoomLevel

Indicates the depth of data that is retrieved relative to the selected member(s) by a Zoom In operation.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

LatestMemberName

Indicates the name of the member to use as the latest time period for dynamic time series retrievals.

SpecifyLatestMember

Controls whether the LatestMemberName is used by dynamic time series retrievals.

MemberRetentionIncludeSelection

Controls whether the selected member is retained along with the other members retrieved by a Zoom In operation.

MemberRetentionRemoveUnselectedGroups

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation removes all dimension groups that are not in the selected group.

MemberRetentionWithinSelectedGroup

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation is applied only to the dimension of the selected member(s). WithinSelectedGroup is only applicable when the sheet contains two or more dimensions of data down a sheet as rows or across a sheet as columns.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ZoomLevel

Indicates the depth of data that is retrieved relative to the selected member(s) by a Zoom In operation.

General

Do an Essbase Update.

ReportScriptID

The ID of the Essbase Script that represents the report script used to update the database.

UpdateSpec

The report spec used to update the database. Example: '"New York" Jan Actual "100-10" Sales 640' will update the value of the given intersection to 640.

ConnectionID

The ID of the Essbase Connection to use for the update operation.

General

Do an Essbase ZoomIn.

SelectedRange

The range to select while doing the Essbase ZoomIn.

EssbaseConnectionID

The ID of the Essbase Connection to use for the ZoomIn operation.

ZoomAcross

If TRUE, the zoom-in dimension will remain in column orientation. If the zoom-in dimension is in page orientation, it will go to column orientation.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MemberRetentionIncludeSelection

Controls whether the selected member is retained along with the other members retrieved by a Zoom In operation.

MemberRetentionRemoveUnselectedGroups

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation removes all dimension groups that are not in the selected group.

MemberRetentionWithinSelectedGroup

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation is applied only to the dimension of the selected member(s). WithinSelectedGroup is only applicable when the sheet contains two or more dimensions of data down a sheet as rows or across a sheet as columns.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ZoomLevel

Indicates the depth of data that is retrieved relative to the selected member(s) by a Zoom In operation.

General

Do an Essbase ZoomOut.

SelectedRange

The range to select while doing the Essbase ZoomOut.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None -- Prevents indentation of any member names. SubItems -- Left-justifies ancestors and indents descendants. Totals -- Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.

General

Execute one or more SQL statements.

Driver

The driver to use.

ServletPath

The servlet-path to use.

SQLConnectString

The SQL connect-string to use.

Username

The username to use.

Password

The password to use.

Statements

One or more SQL statements delimited with the specified delimiter.

StatementDelimiter

The delimiter to use to define the end of each statement. The default is the "|" (pipe) character.

Inserts

One or more SQL statements delimited with the specified delimiter. The insert statements are executed if the corresponding statement fails. The number of insert statements must be zero or the same number as the number of Statements.

General

The value to set as the view's SendRangeModificationTrackingEnabled property value. If set to FALSE, the user is not asked whether to save unsaved changes when the view is rebuilt, closed, or retrieved and unsaved changes exist for any send range.

Enabled

The value to set as the view's SendRangeModificationTrackingEnabled property value. If left blank, the value will be TRUE. If set to FALSE, the user is not asked whether to save unsaved changes when the view is rebuilt, closed, or retrieved and unsaved changes exist for any send range.

AddEssbase

Adds or modifies an Essbase selector configuration.

ResetAllEssbase

Modifies the connection settings for all Essbase selectors.

ConnectionPolicy

Controls whether the view's Essbase connection or a specified Essbase connection is used for the selector. If set to UseSpecifiedConnection, the EssbaseConnectionID argument must be specified. For a non-Essbase view, the connection policy should be set to UseSpecifiedConnection. By default, the argument is UseViewConnection.

ConnectionID

If the ConnectionPolicy is UseSpecifiedConnection, indicates the Essbase connection ID.

EssbaseLoginServiceObjectTypeID

If the ConnectionPolicy is UseSpecifiedConnection, the name of the IEssbaseLoginService to use to prompt for Essbase credentials.

UseAliases

If the ConnectionPolicy is UseSpecifiedConnection, controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. By default, the value is False.

AliasTableName

If the ConnectionPolicy is UseSpecifiedConnection, indicates the name of the alias table used for the selector. If not specified, the Default alias table is used.

ConnectionPolicy

Controls whether the view's Essbase connection or a specified Essbase connection is used for the selector. If set to UseSpecifiedConnection, the EssbaseConnectionID argument must be specified. For a non-Essbase view, the connection policy should be set to UseSpecifiedConnection. By default, the argument is UseViewConnection.

ConnectionID

If the ConnectionPolicy is UseSpecifiedConnection, indicates the Essbase connection ID.

EssbaseLoginServiceObjectTypeID

If the ConnectionPolicy is UseSpecifiedConnection, the name of the IEssbaseLoginService to use to prompt for Essbase credentials.

UseAliases

If the ConnectionPolicy is UseSpecifiedConnection, controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. By default, the value is False.

AliasTableName

If the ConnectionPolicy is UseSpecifiedConnection, indicates the name of the alias table used for the selector. If not specified, the Default alias table is used.

AddToMember

Adds a UDA to a member. Multiple UDA's and/or multiple members can be specified.

RemoveFromMember

Removes one or more UDA's from a specific member.

UDA

A list of one or more UDA's. Multiple UDA's are delimited using a semicolon.

MemberName

A list of one or more member names, which are specified using the Essbase calc member specification formulas. Individual member names and member name ranges are delimited using a comma, and member names that contain a space, numeric character, dash, plus sign, or ampersand, must be enclosed in double quotes. A member range represents members at the same level starting from the first member through to the last member of the range in outline order. The first member and the last member in the range are delimited using a colon. Example of specific members: "New York", Oregon, Texas Example of a member range: mar:dec Example of specific members and a member range: Jan, Feb, Jul:Dec

ConnectionID

(Optional) The ID of the Essbase connection to use for the UDA add/remove operation. If no ConnectionID is specified, the view's EssbaseConnectionID is used.

BackgroundExecute

Controls whether the method is executed asynchronous.

ResultPropertyName

(Optional) The name of the workbook script property that receives the result of the UDA operation. The value is either True, which indicates success, or False, which indicates an error occurred.

EssbaseErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the Essbase add/remove UDA operation fails.

UDA

A list of one or more UDA's. Multiple UDA's are delimited using a semicolon.

MemberName

A list of one or more member names, which are specified using the Essbase calc member specification formulas. Individual member names and member name ranges are delimited using a comma, and member names that contain a space, numeric character, dash, plus sign, or ampersand, must be enclosed in double quotes. A member range represents members at the same level starting from the first member through to the last member of the range in outline order. The first member and the last member in the range are delimited using a colon. Example of specific members: "New York", Oregon, Texas Example of a member range: mar:dec Example of specific members and a member range: Jan, Feb, Jul:Dec

ConnectionID

(Optional) The ID of the Essbase connection to use for the UDA add/remove operation. If no ConnectionID is specified, the view's EssbaseConnectionID is used.

BackgroundExecute

Controls whether the method is executed asynchronous.

ResultPropertyName

(Optional) The name of the workbook script property that receives the result of the UDA operation. The value is either True, which indicates success, or False, which indicates an error occurred.

EssbaseErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the Essbase add/remove UDA operation fails.

BadUdasPropertyName

(Optional) The name of a workbook script property listing UDA's that don't exist. The list is in the form of MemberName;UDA<newLine>.

ContinueOnInvalidUDA

Whether or not to continue removing the specified UDA's if a non-existent UDA is included. If left blank the value will be false.