PageRenderTime 56ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/mcmis/reportico/doc/reportico/tutorial_reportico.design.pkg.html

http://mcmis.googlecode.com/
HTML | 286 lines | 269 code | 13 blank | 4 comment | 0 complexity | ecd45939162524842dd0d91926073aa7 MD5 | raw file
Possible License(s): LGPL-2.1 
    

  1. <html>

    2. 

  2. <head>

    3. 

  3. <title>Report Design Mode</title>

    4. 

  4. <link rel="stylesheet" type="text/css" href="../media/style.css">

    5. 

  5. </head>

    6. 

  6. <body>

    7. 

  7. 

    8. 

  8. <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">

    9. 

  9.   <tr>

    10. 

  10.     <td width="100%">

    11. 

  11. 			<table width="100%" height="78" border="0" align="left" cellpadding="0" cellspacing="0" bgcolor="#FFFFFF" id="topnav">

    12. 

  12. 			<tr>

    13. 

  13. 				<!-- Header Side -->

    14. 

  14. 				<td width="17">

    15. 

  15. 					<img height="78" src="media/reportico100.png"/>

    16. 

  16. 				</td>

    17. 

  17. 				<td align="right"></td>

    18. 

  18. 				<td align="center">

    19. 

  19. 					<table width="100%" height="60" border="0" align="left" cellpadding="0" cellspacing="0">

    20. 

  20. 						<tr>

    21. 

  21. 							<td valign="top" align="left">

    22. 

  22. 							<img src="media/repbanner.png"/></td>

    23. 

  23. 							</td>

    24. 

  24. 						</tr>

    25. 

  25. 						<tr>

    26. 

  26. 							<td align="center" valign="bottom" class="topmenucell">

    27. 

  27. 								<nobr>

    28. 

  28. 								&nbsp;

    29. 

  29. 								</nobr>

    30. 

  30. 							</td>

    31. 

  31. 						</tr>

    32. 

  32. 					</table>

    33. 

  33. 				</td>

    34. 

  34. 				<td width="103" class="toplogincell">

    35. 

  35. 					&nbsp;

    36. 

  36. 				</td>

    37. 

  37. 			</tr>

    38. 

  38. 			</table>

    39. 

  39. </td>

    40. 

  40.   </tr>

    41. 

  41.   <!--tr>

    42. 

  42.     <td class="header_top">reportico</td>

    43. 

  43.   </tr-->

    44. 

  44.   <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>

    45. 

  45.   <tr>

    46. 

  46.     <td class="header_menu">

    47. 

  47.   		  [ <a href="../classtrees_reportico.html" class="menu">class tree: reportico</a> ]

    48. 

  48. 		  [ <a href="../elementindex_reportico.html" class="menu">index: reportico</a> ]

    49. 

  49. 		  [ <a href="../elementindex.html" class="menu">all elements</a> ]

    50. 

  50.     </td>

    51. 

  51.   </tr>

    52. 

  52.   <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>

    53. 

  53. </table>

    54. 

  54. 

    55. 

  55. <table width="100%" border="0" cellpadding="0" cellspacing="0">

    56. 

  56.   <tr valign="top">

    57. 

  57.     <td width="200" class="menu">

    58. 

  58.       <b>Packages:</b><br />

    59. 

  59.               <a href="../li_reportico.html">reportico</a><br />

    60. 

  60.             <br /><br />

    61. 

  61. 		<b>Tutorials/Manuals:</b><br />

    62. 

  62. 					<strong>Package-level:</strong>

    63. 

  63. 							<ul>

    64. 

  64. 	<li type="square"><a href="../reportico/tutorial_reportico.pkg.html">Reportico Tutorial And User Manual</a>

    65. 

  65. <ul>

    66. 

  66. 	<li type="square"><a href="../reportico/tutorial_reportico.manual.pkg.html">Reportico User Manual</a>

    67. 

  67. <ul>

    68. 

  68. 	<li type="square"><a href="../reportico/tutorial_reportico.quickstart.pkg.html">Reportico Installation</a>

    69. 

  69. </ul>

    70. 

  70. 
<ul>

    71. 

  71. 	<li type="square"><a href="../reportico/tutorial_reportico.gettingstarted.pkg.html">Getting Started</a>

    72. 

  72. </ul>

    73. 

  73. 
<ul>

    74. 

  74. 	<li type="square"><a href="../reportico/tutorial_reportico.structure.pkg.html">Reportico Installation Structure</a>

    75. 

  75. </ul>

    76. 

  76. 
<ul>

    77. 

  77. 	<li type="square"><a href="../reportico/tutorial_reportico.using.pkg.html">Running Reportico - Options</a>

    78. 

  78. </ul>

    79. 

  79. 
<ul>

    80. 

  80. 	<li type="square"><a href="../reportico/tutorial_reportico.security.pkg.html">Reportico Security</a>

    81. 

  81. </ul>

    82. 

  82. 
<ul>

    83. 

  83. 	<li type="square"><a href="../reportico/tutorial_reportico.projects.pkg.html">Projects</a>

    84. 

  84. </ul>

    85. 

  85. 
<ul>

    86. 

  86. 	<li type="square"><a href="../reportico/tutorial_reportico.menus.pkg.html">Report Menus</a>

    87. 

  87. </ul>

    88. 

  88. 
<ul>

    89. 

  89. 	<li type="square"><a href="../reportico/tutorial_reportico.prepare.pkg.html">Report Preparation and Execution</a>

    90. 

  90. </ul>

    91. 

  91. 
<ul>

    92. 

  92. 	<li type="square"><a href="../reportico/tutorial_reportico.design.pkg.html">Report Design Mode</a>

    93. 

  93. <ul>

    94. 

  94. 	<li type="square"><a href="../reportico/tutorial_reportico.format.pkg.html">The Design Format Menu</a>

    95. 

  95. </ul>

    96. 

  96. 
<ul>

    97. 

  97. 	<li type="square"><a href="../reportico/tutorial_reportico.customcode.pkg.html">Custom Source Code</a>

    98. 

  98. </ul>

    99. 

  99. 
<ul>

    100. 

  100. 	<li type="square"><a href="../reportico/tutorial_reportico.qrydet.pkg.html">The Query Details Menu</a>

    101. 

  101. </ul>

    102. 

  102. 
<ul>

    103. 

  103. 	<li type="square"><a href="../reportico/tutorial_reportico.assign.pkg.html">The Assignments Menu</a>

    104. 

  104. </ul>

    105. 

  105. 
<ul>

    106. 

  106. 	<li type="square"><a href="../reportico/tutorial_reportico.criteria.pkg.html">The Criteria Menu</a>

    107. 

  107. </ul>

    108. 

  108. 
<ul>

    109. 

  109. 	<li type="square"><a href="../reportico/tutorial_reportico.output.pkg.html">The Output Menu</a>

    110. 

  110. </ul>

    111. 

  111. 
<ul>

    112. 

  112. 	<li type="square"><a href="../reportico/tutorial_reportico.webservices.pkg.html">Turning Reports into Web Services (currently unavailable)</a>

    113. 

  113. </ul>

    114. 

  114. 
</li></ul>

    115. 

  115. 
</li></ul>

    116. 

  116. 
<ul>

    117. 

  117. 	<li type="square"><a href="../reportico/tutorial_reportico.howto.pkg.html">Reportico Tutorial</a>

    118. 

  118. <ul>

    119. 

  119. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial1.pkg.html">Tutorial No.1 - The Film Listing Report</a>

    120. 

  120. </ul>

    121. 

  121. 
<ul>

    122. 

  122. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial1_1.pkg.html">Tutorial 1 Stage 1 - Creating a basic report</a>

    123. 

  123. </ul>

    124. 

  124. 
<ul>

    125. 

  125. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial1_2.pkg.html">Tutorial 1 Stage 2 - Creating User Entry Criteria</a>

    126. 

  126. </ul>

    127. 

  127. 
<ul>

    128. 

  128. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial1_3.pkg.html">Tutorial 1 Stage 3 - Working with expressions using assignments</a>

    129. 

  129. </ul>

    130. 

  130. 
<ul>

    131. 

  131. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial1_4.pkg.html">Tutorial 1 Stage 4 - Working with groups</a>

    132. 

  132. </ul>

    133. 

  133. 
<ul>

    134. 

  134. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial1_5.pkg.html">Tutorial 1 Stage 5 - Including database graphics into the report</a>

    135. 

  135. </ul>

    136. 

  136. 
<ul>

    137. 

  137. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial2_1.pkg.html">Tutorial 2 - Creating the loan history report</a>

    138. 

  138. </ul>

    139. 

  139. 
<ul>

    140. 

  140. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial3_1.pkg.html">Tutorial 3 - The Monthly Returns Report</a>

    141. 

  141. </ul>

    142. 

  142. 
<ul>

    143. 

  143. 	<li type="square"><a href="../reportico/tutorial_reportico.tutorial4_1.pkg.html">Tutorial 4 - The Late Returns Summary report</a>

    144. 

  144. </ul>

    145. 

  145. 
</li></ul>

    146. 

  146. 
</li></ul>

    147. 

  147. 


    148. 

  148. 							<ul>

    149. 

  149. 	<li type="square"><a href="../reportico/tutorial_reportico.appendix1.pkg.html">Appendix 1 - Reportico Project Configuration parameters</a>

    150. 

  150. </ul>

    151. 

  151. 


    152. 

  152. 							<ul>

    153. 

  153. 	<li type="square"><a href="../reportico/tutorial_reportico.appendix2.pkg.html">Appendix 2 - Reportico URL request parameters</a>

    154. 

  154. </ul>

    155. 

  155. 


    156. 

  156. 									                        <b>Files:</b><br />

    157. 

  157.       	  <div class="package">

    158. 

  158. 			<a href="../reportico/_reportico.php.html">		reportico.php

    159. 

  159. 		</a><br>

    160. 

  160. 	  </div><br />


    161. 

  161.       

    162. 

  162.                 </td>

    163. 

  163.     <td>

    164. 

  164.       <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

    165. 

  165. 

    166. 

  166. <table width="100%" border="0" cellpadding="0" cellspacing="0">

    167. 

  167. <tr>

    168. 

  168. <td width="10%" align="left" valign="bottom"><a href=

    169. 

  169. "../reportico/tutorial_reportico.prepare.pkg.html">Prev</a></td>

    170. 

  170. <td width="80%" align="center" valign="bottom"></td>

    171. 

  171. <td width="10%" align="right" valign="bottom"><a href=

    172. 

  172. "../reportico/tutorial_reportico.format.pkg.html">Next</a></td>

    173. 

  173. </tr>

    174. 

  174. </table>

    175. 

  175. <span><a name="design"></a><h2 class="title">Report Design Mode</h2><a name="design.desintro"></a><h3 class="title">Entering Design Mode</h3><p>You
    176. 

  176.     may only enter design mode when logged in as Administrator.
    177. 

  177.     enabled. Design mode is entered either by selecting the <strong>Design Report</strong> option from the report criteria entry screen.</p><hr />
    178. 

  178. 

  179.     <a name="design.desmod"></a><h3 class="title">Design Mode Overview</h3><p>Use
    180. 

  180.     design mode to create, edit and save your reports. The design mode is
    181. 

  181.     organised as a tabbed menu system .</p><p><img src = "../media/R_08.png"/></p>
    182. 

  182. 

  183. <a name="design.desmod.manipulation"></a><h3 class="title">Report
    184. 

  184.     Manipulation</h3><p>Part of Reportico's power is the ways that database
    185. 

  185.     data can be prepared and manipulated prior and during the main report
    186. 

  186.     query. Reportico provides 3 main ways to achieve this
    187. 

  187.     :-</p><p></p><ol><li><p><strong>Pre-SQLs</strong></p><p>These
    188. 

  188.     are SQL statements that are executed prior to the main report query and
    189. 

  189.     are used to prepare temporary tables or run other SQL statements that could
    190. 

  190.     set a database configuration parameter or perform UPDATEs and DELETEs.
    191. 

  191.     Criteria values selected by the user on the Prepare screen can be
    192. 

  192.     incorporated into these statements. See <a href="../reportico/tutorial_reportico.qrydet.pkg.html#qrydet.PreSQLs">Query Details =&gt; Pre-SQLs</a> for more details.</p></li><li><p><strong>Custom
    193. 

  193.     Code</strong></p><p>This is your own PHP code that is executed after any
    194. 

  194.     Pre-SQLs and before the main report query. This is used as an alternative
    195. 

  195.     to Pre-SQLs or for more complex preparatory work than can be performed in
    196. 

  196.     Pre-SQLs. You have access to the database through the <strong>$_connection</strong> ADODB
    197. 

  197.     class variable where you can create SQL statements and execute them, use
    198. 

  198.     database cursors and transactions. And you have access to the user
    199. 

  199.     criteria through the <strong>$_criteria</strong> variable so that you can pull out relevant data before the main report query uses it.</p><p>Also, this preparatory phase is a
    200. 

  200.     useful feature that can simplify and speed up reports that would otherwise
    201. 

  201.     be slowed down by a large main query consisting of many tables and many
    202. 

  202.     joins. It may be more sensible to place in here ( or in the Pre-SQLs if
    203. 

  203.     appropriate ) statements that prepare a temporary table of data from a
    204. 

  204.     large table that matches the user criteria which can then be linked in
    205. 

  205.     with the rest of the report tables in the main query. See <a href="../reportico/tutorial_reportico.customcode.pkg.html">Custom Source Code</a> for more details.</p><p>Also a
    206. 

  206.     great deal of data reformatting can be done here in database cursors that
    207. 

  207.     can prepare a temporary table with column values that have been
    208. 

  208.     reformatted.</p></li><li><p><strong>Assignments</strong></p><p>These
    209. 

  209.     are snippets of PHP code that are run while the main report query is
    210. 

  210.     running and are used to calculate values for custom report columns based
    211. 

  211.     on the retrieved report data, or they can be used to transform the report
    212. 

  212.     data before being finally presented in the finished report.</p><p>For example, a datetime value coming from the database can be
    213. 

  213.     converted to just the time elemented by entering an assignment that uses
    214. 

  214.     the PHP <strong>substr</strong> function to chop off the date part. Also, an assignment can
    215. 

  215.     concatenate or otherwise reformat many columns into a single
    216. 

  216.     one.</p><p>Also, assignments can be made to custom user columns that
    217. 

  217.     may be calculations based on the report data such a sums, averages etc.</p><p>Conditions may be applied to an assignment so that the
    218. 

  218.     assignment is only performed if a certain condition is met. For example,
    219. 

  219.     if a numeric column is negative it could be reformatted to show the number
    220. 

  220.     in brackets or in red by surrounding it in html tags that alter the colour
    221. 

  221.     (although that wouldn't work in PDF
    222. 

  222.     output). See <a href="../reportico/tutorial_reportico.assign.pkg.html">The Assignments Menu</a> for more details.</p></li></ol><hr />
    223. 

  223. 

  224. <a name="design.toplevel"></a><h3 class="title">Top Level Menu</h3><p><table border = "1"><caption>Top Level Menu Options</caption><colgroup span = "2"/><col align = "left"></col>
    225. 

  225.           <col align = "left"></col>
    226. 

  226.             <tbody><tr><td valign = "top">Project Menu</td>
    227. 

  227.               <td>Returns to the project menu selection screen</td></tr>
    228. 

  228. <tr><td valign = "top">Admin Menu</td>
    229. 

  229. <td>Returns you to the Administration Page</td></tr>
    230. 

  230. <tr><td valign = "top">Run Report</td>
    231. 

  231. <td>Returns to the Report Criteria Entry Page</td></tr>
    232. 

  232. <tr><td valign = "top">Report File</td><td>Identifies the name of the report definition currently
    233. 

  233.     working on.</td></tr>
    234. 

  234. <tr><td valign = "top">Save button</td><td><p>Saves the
    235. 

  235.     current report to disk. The file will be saved in the projects area with the
    236. 

  236.     named displayed in the Report File box.</p><p>To save with a different name
    237. 

  237.     change this text and press the Save button. From then on any modifications
    238. 

  238.     you will relate to that new file
    239. 

  239.     name.</p></td></tr>
    240. 

  240. <tr><td valign = "top">New Report</td>
    241. 

  241. <td>Creates an empty report so you can start from scratch</td></tr></tbody></table></p><hr /><hr />
    242. 

  242. 

  243.     <a name="design.desrep"></a><h3 class="title">Tab Menus</h3><p>Each tabbed
    244. 

  244.     menu is described in detail in the following chapters. The top level
    245. 

  245.     tabbed menu comprises the following options
    246. 

  246.     :-</p><p><table border = "1"><caption></caption><colgroup span = "2"/><col align = "left"></col><col align = "left"></col><tbody><tr><td>Format</td><td>Provides
    247. 

  247.     set up of general presentation parameters for the report such as report
    248. 

  248.     title, description, paging options and custom
    249. 

  249.     code.</td></tr><tr><td>Query Details</td><td>Entry of main
    250. 

  250.     report query that fetches the data for displaying on report. Set up of
    251. 

  251.     column labels, justification, visibility
    252. 

  252.     etc</td></tr><tr><td>Assignments</td><td>Set up of
    253. 

  253.     expressions such as calculations and string manipulation to be performed
    254. 

  254.     on the report data. Also used for reporting graphical data from
    255. 

  255.     database</td></tr><tr><td>Criteria</td><td>Set up of the
    256. 

  256.     criteria items and expand/lookup options that the user will use to select
    257. 

  257.     from on the Prepare
    258. 

  258.     screen.</td></tr><tr><td>Output</td><td>Set up of grouping,
    259. 

  259.     graphs, page formatting for PDF
    260. 

  260.     etc</td></tr></tbody></table></p><hr /></span>

    261. 

  261. <table width="100%" border="0" cellpadding="0" cellspacing="0">

    262. 

  262. <tr>

    263. 

  263. <td width="33%" align="left" valign="top"><a href="../reportico/tutorial_reportico.prepare.pkg.html">Prev</a></td>

    264. 

  264. <td width="34%" align="center" valign="top"><a href=

    265. 

  265. "../reportico/tutorial_reportico.manual.pkg.html">Up</a></td>

    266. 

  266. <td width="33%" align="right" valign="top"><a href=

    267. 

  267. "../reportico/tutorial_reportico.format.pkg.html">Next</a></td>

    268. 

  268. </tr>

    269. 

  269. 

    270. 

  270. <tr>

    271. 

  271. <td width="33%" align="left" valign="top">Report Preparation and Execution</td>

    272. 

  272. <td width="34%" align="center" valign="top">Reportico User Manual</td>

    273. 

  273. <td width="33%" align="right" valign="top">The Design Format Menu</td>

    274. 

  274. </tr>

    275. 

  275. </table>

    276. 

  276.         <div class="credit">

    277. 

  277. 		    <hr />

    278. 

  278. 		    Documentation generated on Fri, 14 Oct 2011 23:43:39 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>

    279. 

  279. 	      </div>

    280. 

  280.       </td></tr></table>

    281. 

  281.     </td>

    282. 

  282.   </tr>

    283. 

  283. </table>

    284. 

  284. 

    285. 

  285. </body>

    286. 

  286. </html>
    287.