Build a DataCache from the results of a script.
Overload Name | Description |
---|---|
CartesianList | Build a DataCache based on the cartesian product of values from two or more delimited string lists. |
DelimitedString | Build a DataCache from a list of values specified by a delimited string. |
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 (7.3) | 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 (Hidden in: 8.0.0) |
Add the results of a SQL query to a DataCache.
AddDataCache.SQLScript is no longer supported. |
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: Multi-column: |
Build a DataCache based on the cartesian product of values from two or more delimited string lists.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
ListDelimiter | The delimiter to use to define the end of each List. The default is ",". |
Delimiter | The delimiter to use to define the end of each value. The default is ";". |
ScriptResultColumnCount | The number of columns that will be in each row of the script result. |
Build a DataCache from a list of values specified by a delimited string.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
Delimiter | The delimiter to use to define the end of each value. The default is ";". |
RowDelimiter | The delimiter to use to determine the end of each row of data. |
Add information about a list of Essbase members, determined by whether they are ancestors of a specified member, to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
MaxReturnCount | Override default maximum of 64000. |
UseXMLCache |
Whether to use the cache instead of querying Essbase.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add information about Essbase dynamic-time-series members to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AliasTableName | The Alias table from which alias names are returned. |
ReturnType |
Specifies what information is retrieved for each member.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
UseXMLCache |
Whether to use the cache instead of querying Essbase.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add the results of an Essbase MDX script to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataCacheName | The name of the table will be used to lookup values from it. |
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.
Specify one of the following values or an arbitrary value:
<blank> Name Alias UniqueName
|
AliasTableName | The Alias table from which alias names are returned. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
EssbaseScriptID (7.6) | The ID of the Essbase Script that represents the script to run. |
Add the results of an Essbase member query to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseScriptID (7.3) | The ID of the Essbase Script that represents the script to run. |
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
Add the results of multiple Essbase member-queries to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Queries | Query strings used to retrieve member information. |
AliasTableName | The Alias table from which alias names are returned. |
Add information about a list of Essbase members, generated from an Essbase report script, to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseScriptID (7.3) | The ID of the Essbase Script that represents the script to run. |
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
AliasTableName | The Alias table from which alias names are returned. |
ReturnType |
Specifies what information is retrieved for each member.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
MaxReturnCount | Override default maximum of 64000. |
Add information about Essbase members of a specified generation to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
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.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add information about Essbase members of a specified level to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
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.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add information about a list of Essbase members, determined by their relationship to a specified member, to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> Ancestors BottomLevel Children Descendants Dimension Parent SameGeneration SameLevel Siblings
|
SearchDimension | Dimension to search - if restricting to a single dimension. |
ReturnType |
Specifies what information is retrieved for each member.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
IncludeMember |
Flag indicating whether to include the base member in the returned array.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add information about a list of Essbase members, determined by a search of the outline, to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> Aliases Members MembersAndAliases
|
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.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
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.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add information about a list of Essbase members, determined by whether they have a specified UDA, to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
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.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
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.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add information about a specified list of Essbase members to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Members | Member names used as search criteria, delimited by semicolon. |
ReturnType |
Specifies what information is retrieved for each member.
Specify one of the following values or an arbitrary value:
<blank> Basic Extended Limited Standard
|
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.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Add the results of an Essbase report script to a DataCache.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseConnectionID | The Essbase connection ID. |
Username | The username to use. |
Password | The password to use. |
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
EssbaseScriptID (7.3) | The ID of the Essbase Script that represents the script to run. |
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
Build a DataCache from a Dodeca SQLPassthroughDataSet.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataSetID | The QueryName of the SQLPassthroughDataSet to run. |
Add the results of a SQL query to a DataCache.
AddDataCache.SQLScript is no longer supported.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
ScriptText |
The text of the script that will be run. The script will receive token replacement before being 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. |
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:
Multi-column:
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DataCacheName | The name of the table will be used to lookup values from it. |
Initialize |
Whether to initiaze the DataCache.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
AllowDuplicates (8.0) |
Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimLeft |
Whether to trim whitespace from the left of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
TrimRight |
Whether to trim whitespace from the right of all values. If blank FALSE will be used.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Shared |
Whether to carry the DataCache forward when opening one view from another.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |