702556f3ea896a337d08227e09b0bdc815b1238d
Guides/Report-Lifecycle.md
| ... | ... | @@ -40,28 +40,21 @@ This outlines the call structure when accessing the report viewer page as it per |
| 40 | 40 | 1. **[[InitializeReporting|http://wiki.izenda.us/FAQ/InitializeReporting]]:** This is called by default again whenever you access a reporting page. |
| 41 | 41 | 2. **[[ReportViewerConfig|http://wiki.izenda.us/API/CodeSamples/Javascript/ReportViewerConfig]]: (webServer)** This is an AJAX command sent by javascript and returns JSON formatted data related to the report viewer configuration. |
| 42 | 42 | 3. **[[GetRenderedReportSet|http://wiki.izenda.us/API/CodeSamples/Javascript/GetRenderedReportSet]]: (webServer)** This AJAX command will get the current report set being loaded by the viewer and return the object to the callback method |
| 43 | - 1. **[[GetReportNameById|/FAQ/GetReportNameById]]:** |
|
| 44 | - 2. **[[PreLoadReportSet|/FAQ/PreLoadReportSet]]:** This is run every time a report is viewed before the report set is loaded from the XML definition. You can perform various pre-processing operations based on the report name. |
|
| 45 | - 3. **[[LoadReportSet|/FAQ/LoadReportSet]]:** The XML definition is loaded and the actual reportSet can be manipulated. Or custom loading operations can be implemented. |
|
| 46 | - 4. **[[PostLoadReportSet|/FAQ/PostLoadReportSet]]:** You may perform post-processing of the reportSet here. The result of the post-processed reportSet will be stored as the CurrentReportSet. |
|
| 47 | - 5. **[[PreExecuteReportSet|/FAQ/PreExecuteReportSet]]:** Occurs before rendering the reportSet to the screen. |
|
| 48 | - 6. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** This call to ProcessDataSet returns the result of the combined filters on the report. |
|
| 49 | - 7. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** This call to ProcessDataSet returns the results of the entire query with pivot columns and filters applied. |
|
| 50 | - 8. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** If grand totals are added, the ProcessDataSet method is called again to generate and return the dataset. |
|
| 51 | - 9. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** The result of the grand totals is returned in this call. Therefore, it will be a one-row dataset. |
|
| 52 | - 9. **[[PostExecuteReportSet|/FAQ/PostExecuteReportSet]]:** Allows any final touch-ups to the report to be made before pushing the report to the screen. |
|
| 53 | -8. **[[PreExecuteReportSet|/FAQ/PreExecuteReportSet]]:** |
|
| 54 | - 1. **Detail report:** The following API calls are related specifically to the detail section of the report. (The reportPart specified is "Detail") |
|
| 55 | - 2. **[[ProcessDataSet|/FAQ/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. |
|
| 56 | - 3. **[[ProcessDataSet|/FAQ/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. |
|
| 57 | - 4. **[[ProcessDataSet|/FAQ/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. |
|
| 58 | - 5. **[[ProcessDataSet|/FAQ/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. |
|
| 59 | - 6. **[[PostExecuteReportSet|/FAQ/PostExecuteReportSet]]:** You can perform any post processing to the actual report here. The [[ReportSet|/API/CodeSamples/ReportSet]] |
|
| 60 | -9. **[[GetFiltersData|/API/CodeSamples/Javascript/GetFiltersData]] (web server):** AJAX call |
|
| 61 | - 1. [[ProcessEqualsSelectList|/FAQ/ProcessEqualsSelectList]] |
|
| 62 | - 2. [[ProcessDataSet|/FAQ/ProcessDataSet]] |
|
| 63 | - 3. [[GetOperatorList|/FAQ/GetOperatorList]]:** This call hooks back into your global and applies the filters on the report using the operators in the list. |
|
| 64 | -11. **[[ReportViewerConfig|/API/CodeSamples/Javascript/RportViewer]] (web server):** |
|
| 65 | -12. **[[GetFiltersData|/API/CodeSamples/Javascript/GetFiltersData]] (webServer):** |
|
| 66 | -13. **[[CrsDataSources|/API/CodeSamples/Javascript/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. |
|
| 67 | -14. **[[GetPivotGuiData|/API/CodeSamples/Javascript/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. |
|
| ... | ... | \ No newline at end of file |
| 0 | + 1. **Detail Report:** The following steps apply to the detail report(The reportPart specified is "Detail"). |
|
| 1 | + 2. **[[GetReportNameById|/FAQ/GetReportNameById]]:** |
|
| 2 | + 3. **[[PreLoadReportSet|/FAQ/PreLoadReportSet]]:** This is run every time a report is viewed before the report set is loaded from the XML definition. You can perform various pre-processing operations based on the report name. |
|
| 3 | + 4. **[[LoadReportSet|/FAQ/LoadReportSet]]:** The XML definition is loaded and the actual reportSet can be manipulated. Or custom loading operations can be implemented. |
|
| 4 | + 5. **[[PostLoadReportSet|/FAQ/PostLoadReportSet]]:** You may perform post-processing of the reportSet here. The result of the post-processed reportSet will be stored as the CurrentReportSet. |
|
| 5 | + 6. **[[PreExecuteReportSet|/FAQ/PreExecuteReportSet]]:** Occurs before rendering the reportSet to the screen. |
|
| 6 | + 7. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** If there are pivot columns in the report, this call to ProcessDataSet returns the result of the values for each pivot column group. This is used at the top of the report as column groupings. |
|
| 7 | + 8. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** This call to ProcessDataSet returns the results of the main query with pivot columns and filters applied. |
|
| 8 | + 9. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** If grand totals are added, the ProcessDataSet method is called again to generate and return column groupings for the totals line. |
|
| 9 | + 10. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** The result of the grand totals is returned in this call. Therefore, it will be a one-row dataset with pivot columns and filters taken into consideration. |
|
| 10 | + 11. **[[PostExecuteReportSet|/FAQ/PostExecuteReportSet]]:** Allows any final touch-ups to the report to be made before pushing the report to the screen. |
|
| 11 | +4. **[[GetFiltersData|/API/CodeSamples/Javascript/GetFiltersData]] (web server):** AJAX call to obtain the filters used on the CurrentReportSet. This is used to display filters on the page. |
|
| 12 | + 1. **[[GetOperatorList|/FAQ/GetOperatorList]]:** This call hooks back into your global and applies the filters on the report using the operators in the list. This is called for as many filters as the CurrentReportSet has. |
|
| 13 | + 2. **[[ProcessEqualsSelectList|/FAQ/ProcessEqualsSelectList]]:** |
|
| 14 | + 3. **[[ProcessDataSet|/FAQ/ProcessDataSet]]:** |
|
| 15 | +5. **[[CrsDataSources|/API/CodeSamples/Javascript/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. |
|
| 16 | + 1. **[[GetOperatorList|/FAQ/GetOperatorList]]:** This is called here in order to return the possible filter operators available for each datasource returned to CrsDataSources. |
|
| 17 | +6. **[[GetPivotGuiData|/API/CodeSamples/Javascript/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. |
|
| ... | ... | \ No newline at end of file |