Understanding Events in the Life of Essbase Excel View

This event provides the opportunity to set view properties, such as adding or editing view tokens, before the view’s user interface is initialized, including selectors.

Most of the view’s properties can be edited from a workbook script using the SetViewPropertyValue method.

To add or edit a view token during the AfterConstruct event, use the View overload of the AddToken method. This is equivalent to editing the view’s ViewTokens property in the View metadata editor.

It is actually quite rare for a workbook script to use the AfterConstuct event link, but when needed, it provides a way to edit view properties before any of the settings are used.

This event occurs after the view user interface is created, and before the view is shown.

Similar to the AfterConstruct event, this event is rarely used by workbook scripts. It is useful, for example, when a view token needs to be added or modified after the user-interface is initialized, which is when the selectors are created and the default selections are set.

This event occurs at the beginning of the build processing.

This event can be cancelled, which cancels the build processing. If the workbook script cancels the event, it should also update the status bar. The SetViewStatus method updates the status icon and text. The SetProgressText method updates the progress text.

This event occurs before the current workbook is closed.

The view can be thought of as a workbook that contains one or more sheets. Even before the first time the view is built, the workbook contains a single empty sheet. Since the view can be built many times, the workbook is closed during the build processing to restore the view to the initial state. Closing the workbook actually removes all the sheets except for the first sheet, which is cleared of values, formulas, and formats.

This event can be cancelled, which cancels the build processing. As with cancelling the BeforeBuild event, the status bar should be updated by the workbook script.

This event occurs after the current workbook is closed.

Even though the Excel template is actually only pulled from the server to the client the first time the view is built or the next time the view is built after the template has changed, this event always occurs before the check is performed that determines whether the template already exists in the client cache and, if so, whether the template needs to be updated.

This event can be cancelled, which cancels the build processing.  As with cancelling the BeforeBuild event, the status bar should be updated by the workbook script.

This event can be used to dynamically control which Microsoft Excel template is used for the view. To do so, use the SetViewPropertyValue method to set the ExcelTemplateBinaryArtifact.ID and ExcelTemplateBinaryArtifact.ID values.

This event occurs after the Microsoft Excel template is either determined to already exist in the client cache or is pulled from the server to the client cache.

This event occurs before the Excel template, which is specified by ExcelTemplateBinaryArtifact property, is loaded.

This event can be cancelled, which cancels the build processing. As with cancelling the BeforeBuild event, the status bar should be updated by the workbook script.

This event occurs after the Microsoft Excel template is loaded.

This event is by far the most frequently used of all the events. It provides the opportunity to dynamically affect the content of the view.

When the view is configured as a cascading view, the following events occur:

This event occurs before the cascade template sheet is copied for each unique combination of cascade source selections.

Although this event can be cancelled, doing so does not cancel the build processing, but rather cancels the creation of the cascade sheets.

If the view’s SummarySheetAdd setting is True, this event occurs before the cascade summary sheet is added.

Cancelling this event prevents the summary sheet from being added.

This event occurs after the cascade sheets are added and the template cascade sheet is deleted.

This concludes the events that occur when the view is configured as a cascading view.

This event occurs before the retrieval of Essbase data begins for the entire workbook. The view’s RetrievePolicy property determines whether all sheets, only sheets that contain one or more named retrieve ranges, or only the active sheet is retrieved.

Cancelling this event bypasses the default retrieve behavior.

This event provides the opportunity to modify the view content before the Essbase retrieve(s) occurs or to intercept the processing with logic implemented by the workbook script.

For each sheet that is retrieved, as determined by the view’s RetrievePolicy property, the following events occur:

This event occurs before tokens are replaced on the sheet.

SheetName is the name of the sheet.

Cancelling this event bypasses the default token replacement behavior for the sheet.

Since the sheet cannot be assumed to be the active sheet, any workbook script method called within the context of this event that applies to the sheet should set SpecifySheetBy to SheetName and set SheetSpec to @EPVal(SheetName).

This event occurs after the tokens are replaced on the sheet.

Since the sheet cannot be assumed to be the active sheet, any workbook script method called within the context of this event should set SpecifySheetBy to SheetName and set SheetSpec to @EPVal(SheetName).

This event occurs before the data is retrieved for all of the Essbase retrieve ranges on the sheet, or if no retrieve ranges exist, for the used range.

SheetName is the name of the sheet.

Cancelling this event bypasses the default retrieve behavior for the sheet.

This event provides the opportunity to modify the sheet content before the Essbase retrieve(s) occurs or to intercept the processing with logic implemented by the workbook script.

Since the sheet cannot be assumed to be the active sheet, any workbook script method called within the context of this event that applies to the sheet should set SpecifySheetBy to SheetName and set SheetSpec to @EPVal(SheetName).

For each retrieve range on the sheet, or if no retrieve ranges exist, the following events occur for the used range:

This event occurs before the Essbase data is retrieved for the range.

SheetName is the name of the sheet that contains the range.

RangeName is the name of the retrieve range. If the used range is being retrieved, the range name is empty.

Cancelling this event bypasses the default retrieve behavior for the range.

This event provides the opportunity to intercept the processing with logic implemented by the workbook script.

Since the sheet cannot be assumed to be the active sheet, any workbook script method called within the context of this event that applies to the sheet should set SpecifySheetBy to SheetName and set SheetSpec to @EPVal(SheetName).

This event occurs after the Essbase data is retrieved for the range.

SheetName is the name of the sheet that contains the range.

RangeName is the name of the retrieve range. If the used range is being retrieved, the range name is empty.

Since the sheet cannot be assumed to be the active sheet, any workbook script method called within the context of this event that applies to the sheet should set SpecifySheetBy to SheetName and set SheetSpec to @EPVal(SheetName).

This concludes the events that occur for each range on the sheet.

This event occurs after all the ranges on the sheet have been retrieved.

SheetName is the name of the sheet.

Since the sheet cannot be assumed to be the active sheet, any workbook script method called within the context of this event that applies to the sheet should set SpecifySheetBy to SheetName and set SheetSpec to @EPVal(SheetName).

This concludes the events that occur for each sheet.

This event occurs after all the sheets, as determined by the view’s RetrievePolicy property, are retrieved.

If the view has CommentRanges, the following events occur:

This event occurs before the comments are set up.

This event occurs after the comments are set up.

This concludes the events that occur when the view has CommentRanges.

This event occurs at the end of the build processing.

This event can be cancelled, which is not typical for an event that occurs after something has happened. This allows a workbook script to cancel the build after the processing based on the content of the view.  For example, if the view does not contain any data, the workbook script can cancel the event, so the view remains covered.