67ac03e09a360b3ea078e3bb169e4ff88c68ec2b
Integration/Tutorials/Navigation.md
| ... | ... | @@ -0,0 +1,62 @@ |
| 1 | +#**Navigation** |
|
| 2 | + |
|
| 3 | +[[_TOC_]] |
|
| 4 | + |
|
| 5 | +###Introduction |
|
| 6 | + |
|
| 7 | +Navigation can be customized globally, for all users, by using the settings.aspx page. It can also be customized on a per-user basis. The two pages which are generally affected most by navigation are the report viewer and the report list. |
|
| 8 | + |
|
| 9 | +###Report List Navigation |
|
| 10 | + |
|
| 11 | +The Reports List page can be completely re-written if you choose. You use the AdHocSettings.AdHocConfig class to return a list of filtered reports, which could then be put into a table or any other html format. The query string format for the links to point to the other pages is as follows, where ReportName is the actual report name from the filtered reports list: |
|
| 12 | + |
|
| 13 | +* Report Viewer links: ReportViewer.aspx?rn=ReportName |
|
| 14 | +* Report Designer links: ReportDesigner.aspx?rn=ReportName&tab=Fields |
|
| 15 | + |
|
| 16 | +By creating a page with these links, you can completely control the Report List navigation. You can also display buttons or other links which further control navigation or integration with your product. |
|
| 17 | + |
|
| 18 | +###Report Viewer Navigation Using Query String Parameters |
|
| 19 | + |
|
| 20 | +The report viewer provides the ability to give links to the users which are generated as reports. This means that you can provide a link to a user and when that link is clicked upon, a report will automatically generate in the needed format and a Download load file dialog will appear. The user does not need to be taken to the page in a browser. The following output types are supported: |
|
| 21 | + |
|
| 22 | +* Portable Document Format (pdf): "&output=pdf" |
|
| 23 | + * Sample link [[http://www.izenda.com/bi/ReportViewer.aspx?rn=Product+List&output=pdf]] |
|
| 24 | +* Microsoft Excel Format: "&output=xls" |
|
| 25 | + * Sample link [[http://www.izenda.com/bi/ReportViewer.aspx?rn=Product+List&output=xls]] |
|
| 26 | +* Microsoft Word Format: "&output=csv" |
|
| 27 | + * Sample link [[http://www.izenda.com/bi/ReportViewer.aspx?rn=Product+List&output=csv]] |
|
| 28 | +* XML Format: "&output=xml" |
|
| 29 | + * Sample link [[http://www.izenda.com/bi/ReportViewer.aspx?rn=Product+List&output=xml]] |
|
| 30 | +* RTF Format: "&output=rtf" |
|
| 31 | + * Sample link [[http://www.izenda.com/bi/ReportViewer.aspx?rn=Product+List&output=rtf]] |
|
| 32 | + |
|
| 33 | +###Simple Mode |
|
| 34 | + |
|
| 35 | +Simple Mode disables the ability in the Report Viewer to load another report, export the report, or add fields and filters to the report. If there are existing filters it allows the ability to change the current filter. |
|
| 36 | + |
|
| 37 | +* Simple Mode Format: "&simple=1" |
|
| 38 | + * Sample link [[http://www.izenda.com/bi/ReportViewer.aspx?rn=Department+Reports/Dashboard&simple=1]] |
|
| 39 | + |
|
| 40 | +###Izenda Reports supports at most 5 query string parameters |
|
| 41 | + |
|
| 42 | +It is also possible that you may want to pass a query string to Izenda which has a filter field parameter already set for the user. To accomplish this you can use the p1value, p2value, p3value, p4value, and p5value parameters. Each of the parameters corresponds to the actual order of filters on the report viewer page. So in this example we see the filter field labels in red next to the filters. Call the filters using the following naming convention: |
|
| 43 | + |
|
| 44 | + |
|
| 45 | + |
|
| 46 | +**Note: The values in "Red" (p1value, etc.) above are for reference to the information below only. The Value(s) spaces need to remain "Blank" in the Report Designer. |
|
| 47 | + |
|
| 48 | +* **p1value,p1value2**: "Between" filter operator, ReportViewer.aspx?rn=SomeReport&p1value=1/1/2005&p1value2=1/1/2008 |
|
| 49 | +* **p2value**: "Equals" filter operator,ReportViewer.aspx?rn=SomeReport&p2value=USA |
|
| 50 | +* **p3value**: "Equals" filter operatorReportViewer.aspx?rn=SomeReport&p3value=SomeCompany |
|
| 51 | +* **p4value**: "Greater Than" filter operatorReportViewer.aspx?rn=SomeReport&p4value=15 |
|
| 52 | +* **p5value**: not used in this example (maximum amount of parameters reached) |
|
| 53 | + |
|
| 54 | +*Note: p1value2 is only valid due to using the "Between" operator and would not be valid when working with other operators.* |
|
| 55 | + |
|
| 56 | +You can combine filters together and add an output type. Examine this example: |
|
| 57 | + |
|
| 58 | +* ReportViewer.aspx?rn=Product+List&p1value=1/1/2005&p1value2=1/1/2008&p2value=USA&output=pdf |
|
| 59 | + |
|
| 60 | +###Get just the report |
|
| 61 | + |
|
| 62 | +All of the above commands can also be accomplished by replacing ReportViewer.aspx with rs.aspx and appending the appropriate query string. This will generate the same report seen in ReportViewer.aspx but without any of the menu items. |
|
| ... | ... | \ No newline at end of file |