#Report Lifecycle

##About

The Izenda reports API has a various methods and properties that can be overridden to implement custom functionality that allows you to control reports, charts, and data at a granular level. Below you will find the order in which those methods are called and the context in which it is executed. You can find out more about our settings API by viewing the AdHocSettings page.

##ReportList.aspx

This outlines the call structure when accessing the report list page as it pertains to reports and API hooks.

  1. InitializeReporting: The first call must be to InitializeReporting before other API calls are made. This sets the groundwork for all reporting operations. It is recommended that all pages using Izenda reports call this method in the code-behind.
  2. GetReportListConfig (webServer): GetReportListConfig is an ajax call launched by the report list that is necessary to be called before the report list can be initialized.
  3. ReportListDataLite (webServer): ReportListDataLite is an ajax call launched after the configuration is obtained by the report list and returns a JSON formatted object to the javascript callback specified.
  4. FilteredListReportsDictionary: FilteredListReportsDictionary is called upon requesting the report list data above and can be manipulated in global.asax. This will also get the database schema from the cache or cache it if it's not cached.
  5. ListReports: The ListReports method returns a broader range of reports and can also be manipulated in global.asax. This method performs differently depending on if you use DatabaseAdHocConfig or FileSystemAdHocConfig. This will iterate through each report and perform the following operations:
  6. GetReportNameById: This will simply return the report name based on the ID of the report. This will run for each report before any other steps below are run.
  7. ClearCachedReportSet: The cache is cleared in preparation for the new set of reports.
  8. PreLoadReportSet: Here, PreLoadReportSet
  9. LoadReportSet: It is at this point that XML definitions are read for each report and the ReportInfo is returned. If you want to perform your own processing of the report. Note that your customizations will only be kept if you perform them after base.LoadReportSet is called (if it's called).
  10. PostLoadReportSet: Alternately, you can perform any post-processing you wish to do in the PostLoadReportSet method. These three methods will always be called when fetching report definitions.
  11. Caching: Caching occurs at this point (turned on by default) so the definitions will not have to be loaded again.
  12. Thumbnails: The cached reports are accessed and thumbnails are loaded if GenerateThumbnails is on.

##ReportDesigner

This outlines the call structure when accessing the report designer page as it pertains to reports and API hooks.

  1. InitializeReporting: This should be called via the OnPreInit function in the page's code behind file, like all Izenda reports pages (except rs.aspx).
  2. FilteredListReportsDictionary: This will perform the same operation as in the report list.
  3. ListReports: If this is the first call to ListReports, or the cache was recently invalidated, this will obtain the reports as before. Otherwise it will skip the individual processing of reports in favor of the cache.
  4. GetReportNameById: Called like above.
  5. GetOperatorList: The ReportDesigner now gets a list of operators available for the SqlType context. If customizations to the operator list are required, it can be done here.

##Report Viewer

This outlines the call structure when accessing the report viewer page as it pertains to reports and API hooks.

  1. InitializeReporting: This is called by default again whenever you access a reporting page.
  2. ReportViewerConfig: (webServer) This is an AJAX command sent by javascript and returns JSON formatted data related to the report viewer configuration.
  3. GetRenderedReportSet: (webServer) This AJAX command will get the current report set being loaded by the viewer and return the object to the callback method
  4. **[GetReportNameById /FAQ/GetReportNameById
  5. PreLoadReportSet: This is run every time a report is viewed before the report set is loaded from the XML definition. You can perform various operations based on the report name.
  6. LoadReportSet: This occurs immediately after PreLoadReportSet and
  7. PostLoadReportSet: You may perform post-processing of the reportSet here. The result of the post-processed reportSet will be stored as the CurrentReportSet.
  8. GetRenderedReportSet: (webServer) This is an AJAX call that will return the HTML of the report and the id of the calling method (getrenderedreportset)
  9. PreExecuteReportSet:
  10. Detail report: The following API calls are related specifically to the detail section of the report. (The reportPart specified is "Detail")
  11. ProcessDataSet: This call to ProcessDataSet returns the headers of the Detail table. It contains one table with as many columns as are in the report before pivot columns are added and one row.
  12. ProcessDataSet: This call to ProcessDataSet returns the body of the Detail table. This is where post processing of report viewer data can be performed. The difference between the previous call and this one is the presence of pivot columns and more than one row.
  13. ProcessDataSet: The next call to ProcessDataSet is to get the pivot column parameters. It will give as many values as specified by your function returns. For instance, using a Group(Year) function when your data has data for 2010, 2011, 2012, and 2013 will return a datatable with four columns at this particular time. This will repeat for as many pivot columns are on your report.
  14. ProcessDataSet: Then we have a call to ProcessDataSet with the totals line being returned as the dataset. Generally, this table will have as many columns as the total columns on your report (plus pivot columns) and one row.
  15. PostExecuteReportSet: You can perform any post processing to the actual report here. The ReportSet
  16. GetFiltersData (web server): AJAX call
  17. ProcessEqualsSelectList
  18. ProcessDataSet
  19. GetOperatorList:** This call hooks back into your global and applies the filters on the report using the operators in the list.
  20. ReportViewerConfig (web server):
  21. GetFiltersData (webServer):
  22. CrsDataSources (web server): Sends an AJAX call to the web server to get the current report set's datasources. This is used by the report viewer to get the data used in the inline filter editor.
  23. GetPivotGuiData (web server): Sends an AJAX call to the web server to get the pivot data for use on the pivots tab on the viewer.

Izenda Logo