WBS Essbase, Dodeca 8.3
Events
AfterInitialRetrieveFromBuild
Occurs after the initial retrieve, which is performed while building the view.
AfterRangeReplaceTokens
Occurs after a range token replacement.
Property | Description |
---|---|
RangeName |
Defined name or reference of the range that contains the tokens. |
SheetName |
Name of the sheet that contains the range. |
AfterRangeRetrieve
Occurs after a range is retrieved.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieved range. When the "used range" is the retrieved range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
AfterRangeSend
Occurs after a range is sent.
Property | Description |
---|---|
RangeName |
Defined name or reference of the send range. When the "used range" is the send range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
EssConnection |
Essbase connection object reference, which can be used to get the following properties: Application, CubeViewName, ClusterName, Database, OLAPServer, Stateless. For example, @EPVal(EssConnection.Application) returns the Essbase application associated with the connection. |
AfterSheetKeepOnly
Occurs after an Essbase keep-only operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the keep-only operation was performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
AfterSheetPivot
Occurs after an Essbase pivot operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the pivot operation was performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
AfterSheetRemoveOnly
Occurs after an Essbase remove-only operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the remove-only operation was performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
AfterSheetReplaceTokens
Occurs after tokens have been replaced on a sheet.
Property | Description |
---|---|
SheetName |
Name of the sheet that contains the tokens. |
AfterSheetReport
Occurs after an Essbase report operation.
Property | Description |
---|---|
SheetName |
Name of the sheet that contains the report data. |
ReportSpec |
Report specification string that generated the report data. |
EssConnection |
Essbase connection object reference, which can be used to get the following properties: Application, CubeViewName, ClusterName, Database, OLAPServer, Stateless. For example, @EPVal(EssConnection.Application) returns the Essbase application associated with the connection. |
AfterSheetRetrieve
Occurs after all Essbase retrieves, if any, are performed for the sheet. If the view's retrieve policy allows the sheet to be retrieved, the event occurs whether or not any retrieves are actually performed.
Property | Description |
---|---|
SheetName |
Name of the sheet. |
AfterSheetRetrieveOperation
Occurs after any Essbase retrieve operation (KeepOnly, RemoveOnly, Pivot, Report, Retrieve, ZoomIn, and ZoomOut) is performed on the sheet.
Property | Description |
---|---|
SheetName |
Name of the sheet. |
RangeName |
Keep Only, Remove Only, Pivot, Zoom In, Zoom Out operations only: Defined name or reference of the retrieve range on which the remove-only operation was performed. When the "used range" is the retrieve range, the property value is null. |
AfterSheetSend
Occurs after all Essbase sends, if any, are performed for the sheet. If the view's send policy allows the sheet to be sent, the event occurs whether or not any sends are actually performed.
Property | Description |
---|---|
SheetName |
Name of the sheet. |
AfterSheetZoomIn
Occurs after an Essbase zoom-in operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the zoom-in operation was performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
DrillLevel |
Indicates the drill-level of the zoom-in operation, which is one of the following: NextLevel, AllLevels, BottomLevel, SiblingLevel, SameLevel, SameGeneration, CalcLevel |
ZoomAcross |
A boolean that indicates whether the zoom-in was across (True) or down (False). |
AfterSheetZoomOut
Occurs after an Essbase zoom-out operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the zoom-out operation was performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
BeforeOpenViewForDataCells
Occurs before this view opens a target view for the context represented by one or more data cells.
Property | Description |
---|---|
SheetName |
Name of the sheet that contains the data cell(s) for which the target view is being opened. |
TargetViewID |
ID of the target view. |
BeforeOpenViewForMemberCells
Occurs before this view opens a target view for the context represented by one or more member cells.
Property | Description |
---|---|
SheetName |
Name of the sheet that contains the member cell(s) for which the target view is being opened. |
TargetViewID |
ID of the target view. |
BeforeRangeReplaceTokens
Occurs before a range token replacement.
Property | Description |
---|---|
RangeName |
Defined name or reference of the range that contains the tokens. |
SheetName |
Name of the sheet that contains the range. |
BeforeRangeRetrieve
Occurs before a range is retrieved.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieved range. When the "used range" is the retrieved range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
BeforeRangeSend
Occurs before a range is sent.
Property | Description |
---|---|
RangeName |
Defined name or reference of the send range. When the "used range" is the send range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
EssConnection |
Essbase connection object reference, which can be used to get the following properties: Application, CubeViewName, ClusterName, Database, OLAPServer, Stateless. For example, @EPVal(EssConnection.Application) returns the Essbase application associated with the connection. |
BeforeSheetKeepOnly
Occurs before an Essbase keep-only operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the keep-only operation is being performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
BeforeSheetPivot
Occurs before an Essbase pivot operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the pivot operation is being performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
BeforeSheetRemoveOnly
Occurs before an Essbase remove-only operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the remove-only operation is being performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
BeforeSheetReplaceTokens
Occurs before tokens are replaced on a sheet.
Property | Description |
---|---|
SheetName |
Name of the sheet that contains the tokens. |
BeforeSheetReport
Occurs before an Essbase report operation.
Property | Description |
---|---|
SheetName |
Name of the sheet that contains the report data. |
ReportSpec |
Report specification string that generated the report data. |
EssConnection |
Essbase connection object reference, which can be used to get the following properties: Application, CubeViewName, ClusterName, Database, OLAPServer, Stateless. For example, @EPVal(EssConnection.Application) returns the Essbase application associated with the connection. |
BeforeSheetRetrieve
Occurs before all Essbase retrieves, if any, are performed for the sheet. If the view's retrieve policy allows the sheet to be retrieved, the event occurs whether or not any retrieves are actually performed.
Property | Description |
---|---|
SheetName |
Name of the sheet. |
BeforeSheetRetrieveOperation
Occurs before any Essbase retrieve operation (KeepOnly, RemoveOnly, Pivot, Report, Retrieve, ZoomIn, and ZoomOut).
Property | Description |
---|---|
SheetName |
Name of the sheet. |
RangeName |
Keep Only, Remove Only, Pivot, Zoom In, Zoom Out operations only: Defined name or reference of the retrieve range on which the remove-only operation is being performed. When the "used range" is the retrieve range, the property value is null. |
BeforeSheetSend
Occurs before all Essbase sends, if any, are performed for the sheet. If the view's send policy allows the sheet to be sent, the event occurs whether or not any sends are actually performed.
Property | Description |
---|---|
SheetName |
Name of the sheet. |
BeforeSheetZoomIn
Occurs before an Essbase zoom-in operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the zoom-in operation is being performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |
DrillLevel |
Indicates the drill-level of the zoom-in operation, which is one of the following: NextLevel, AllLevels, BottomLevel, SiblingLevel, SameLevel, SameGeneration, CalcLevel |
ZoomAcross |
A boolean that indicates whether the zoom-in is across (True) or down (False). |
BeforeSheetZoomOut
Occurs before an Essbase zoom-out operation.
Property | Description |
---|---|
RangeName |
Defined name or reference of the retrieve range on which the zoom-out operation is being performed. When the "used range" is the retrieve range, the property value is null. |
SheetName |
Name of the sheet that contains the range. |