Adds or removes one or more UDA's assigned to one or more members.
| Overload Name | Description |
|---|---|
| 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. |
Adds a UDA to a member. Multiple UDA's and/or multiple members can be specified.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| 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. |
Removes one or more UDA's from a specific member.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| 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 (8.0) |
(Optional) The name of a workbook script property listing UDA's that don't exist. The list is in the form of MemberName;UDA |
| ContinueOnInvalidUDA (8.0) |
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.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|