reports:custom_reports

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
reports:custom_reports [2019/09/04 15:17] – ↷ Links adapted because of a move operation loureports:custom_reports [2021/08/10 11:48] (current) – Gary Willetts
Line 1: Line 1:
-{{indexmenu_n>100}} +{{indexmenu_n>110}} 
-===== 16.10. Custom reporting tutorial ===== +====== 13.12. Custom reports ====== 
 +{{ :reports:pasted:20210702-000119.png?600 }} 
 +Choosing this item brings up a window for creating a custom report: 
 {{ :reports:cust_rprt_01.png?450 }} {{ :reports:cust_rprt_01.png?450 }}
  
Line 9: Line 10:
  
 == Report table == == Report table ==
- 
 A list of tables on the left to choose which table (which type of records) you want to report on, e.g. Names, Items, etc. A list of tables on the left to choose which table (which type of records) you want to report on, e.g. Names, Items, etc.
  
Line 15: Line 15:
  
 == Which records == == Which records ==
- 
 A series of radio buttons to choose which records to examine A series of radio buttons to choose which records to examine
  
Line 23: Line 22:
  
 == Report form == == Report form ==
- +A drop down list displaying available options:
-A drop down list displaying available options+
  
   * New report   * New report
Line 32: Line 30:
     * The default location for saving your custom reports is My Documents\mSupply\custom reports; it is important to note here that any custom reports you have created // should not// be saved in the My Documents\mSupply\Reports folder, otherwise problems may arise.     * The default location for saving your custom reports is My Documents\mSupply\custom reports; it is important to note here that any custom reports you have created // should not// be saved in the My Documents\mSupply\Reports folder, otherwise problems may arise.
   * New label layout   * New label layout
-    * presents you with the label editor, where you can design and save label layouts. These are useful for use with names for addressing envelopes, and with Items for making tags for labeling shelves in your warehouse.+    * Presents you with the label editor, where you can design and save label layouts. These are useful for use with names for addressing envelopes, and with Items for making tags for labeling shelves in your warehouse.
     * If you choose this option the "Order by" window will appear after a query. This allows you to sort the records into a particular order before printing labels. (In a nutshell: Drag fields from the list on the left to the list on the right to use them for sorting)     * If you choose this option the "Order by" window will appear after a query. This allows you to sort the records into a particular order before printing labels. (In a nutshell: Drag fields from the list on the left to the list on the right to use them for sorting)
   * Other items in the menu   * Other items in the menu
-    * if you have saved any reports in the custom reports folder they will be listed here.+    * If you have saved any reports in the custom reports folder they will be listed here.
  
-A list of the fields in each table, and what each field contains is to be found elsewhere in the guide. [[tables:foreign_keys|Field descriptions are here]]+A list of the fields in each table, and what each field contains is given in section [[tables_fields:]].
  
 == Using previously saved layout == == Using previously saved layout ==
- 
 Any report layouts which you have used previously, and saved, may be accessed by clicking on // File >Open // on the menu bar, and selecting the required layout. Any report layouts which you have used previously, and saved, may be accessed by clicking on // File >Open // on the menu bar, and selecting the required layout.
  
-===== Using the Query Search editor ===== +===== Using the Query search editor =====
 There are now many reports included in mSupply(r), but there may still be occasions when you require a report that we have not included. The query editor is a bit daunting, but is very powerful and once you are familiar with its capabilities, your competence to access the precise information you may require from within the mSupply database will increase significantly. There are now many reports included in mSupply(r), but there may still be occasions when you require a report that we have not included. The query editor is a bit daunting, but is very powerful and once you are familiar with its capabilities, your competence to access the precise information you may require from within the mSupply database will increase significantly.
  
Line 66: Line 62:
 For more detailed information on the Query search editor see: http://doc.4d.com/4Dv16R6/4D/16-R6/Query-editor.300-3561635.en.html For more detailed information on the Query search editor see: http://doc.4d.com/4Dv16R6/4D/16-R6/Query-editor.300-3561635.en.html
  
-=== Designing a Report === +=== Designing a report ===
 The designing of two custom report is now described: The designing of two custom report is now described:
  
Line 76: Line 71:
  
 == Report 1 == == Report 1 ==
- 
 Having selected Custom Report from the Reports page in the Navigator, you are presented with this window: Having selected Custom Report from the Reports page in the Navigator, you are presented with this window:
  
Line 104: Line 98:
 There are two operation modes available which generate two specific types of reports: // List// and // Cross table// . Our examples are limited to the // List// mode. The // Cross table // mode// will not be described//. There are two operation modes available which generate two specific types of reports: // List// and // Cross table// . Our examples are limited to the // List// mode. The // Cross table // mode// will not be described//.
 </WRAP> </WRAP>
- 
  
 In the List mode, reports typically display records as a list with break rows where calculations are performed. In the List mode, reports typically display records as a list with break rows where calculations are performed.
Line 139: Line 132:
  
 == Contextual menus == == Contextual menus ==
- 
 The Quick Report editor has contextual menus that make it easy to access certain row, column, and cell operations. Instead of making menu selections or working with the Cell or Column properties areas, you can perform certain operations by displaying a Quick Report contextual menu. The Quick Report editor has contextual menus that make it easy to access certain row, column, and cell operations. Instead of making menu selections or working with the Cell or Column properties areas, you can perform certain operations by displaying a Quick Report contextual menu.
  
Line 151: Line 143:
 {{ :reports:contx_menus.png?450 }} {{ :reports:contx_menus.png?450 }}
  
-== Selecting Rows, Columns, and Cells ==+== Selecting rows, columns, and cells ==
  
 When designing a Quick Report, you need to select rows, columns, and cells in the quick report form. A cell is the intersection of a row and a column. When designing a Quick Report, you need to select rows, columns, and cells in the quick report form. A cell is the intersection of a row and a column.
Line 159: Line 151:
   * To select a cell: - Click the cell.   * To select a cell: - Click the cell.
  
-== Adding and Modifying Text == +== Adding and modifying text ==
 You can add or modify text in the quick report form to label parts of the report. For example, if you requested summary calculations, you can label them by adding text to other cells in the Subtotal and Grand total rows. You can add or modify text in the quick report form to label parts of the report. For example, if you requested summary calculations, you can label them by adding text to other cells in the Subtotal and Grand total rows.
  
Line 213: Line 204:
 {{ :reports:cust_rpt2_01.png?500 }} {{ :reports:cust_rpt2_01.png?500 }}
  
-When the Query Editor window appears, expand the [Items] table, and once expanded, move down the list until// code// appears, and select it by clicking on it;the upper panel now shows // [items]code// , the default comparator // is equalto// ,and so to complete the line, move the cursor to the // Value// entry panel in the lower part of the window and enter 'metclp10'. Click on // Add Line// and accept the default conjunction // And// ; In the // Available Fields// panel, shrink the //[Items]// table, expand the //[item_lines]// table and select //batch//, accept the //is equal to// comparator, and enter 'BN1234' in the //Value// entry panel. You have now defined the criteria for the report, and the Query Editor window should look like this:+When the Query Editor window appears, expand the [Items] table, and once expanded, move down the list until// code// appears, and select it by clicking on it;the upper panel now shows // [items]code// , the default comparator // is equal to// ,and so to complete the line, move the cursor to the // Value// entry panel in the lower part of the window and enter 'metclp10'. Click on // Add Line// and accept the default conjunction // And// ; In the // Available Fields// panel, shrink the //[Items]// table, expand the //[item_lines]// table and select //batch//, accept the //is equal to// comparator, and enter 'BN1234' in the //Value// entry panel. You have now defined the criteria for the report, and the Query Editor window should look like this:
  
 {{ :reports:rprt2_qry_editr.png?650 }} {{ :reports:rprt2_qry_editr.png?650 }}
Line 283: Line 274:
 At some time in the future, you may wish to run your reports again. You should, therefore, save a copy of each report in the // Custom Reports// folder; this is performed by clicking on //File// on the menu bar, and selecting //Save// or //Save as//, giving the report a name, and saving it in the //Custom Reports// folder, or any other appropriate location of your choice. Then when you're ready to run the report next time, having specified your criteria in the //Query Editor//, when the //Quick Report// window first appears, click on //File// on the menu bar, select //Open,// and retrieve the desired report from its saved location, preview it and print it. At some time in the future, you may wish to run your reports again. You should, therefore, save a copy of each report in the // Custom Reports// folder; this is performed by clicking on //File// on the menu bar, and selecting //Save// or //Save as//, giving the report a name, and saving it in the //Custom Reports// folder, or any other appropriate location of your choice. Then when you're ready to run the report next time, having specified your criteria in the //Query Editor//, when the //Quick Report// window first appears, click on //File// on the menu bar, select //Open,// and retrieve the desired report from its saved location, preview it and print it.
  
-=== Using custom methods in Quick Report Columns === +=== Using custom methods in quick report columns ===
 Sometimes you will need to use a custom method in a column to extract data from a related table. Sometimes you will need to use a custom method in a column to extract data from a related table.
  
Line 307: Line 297:
  
  
-// Previous:  [[reports:pagepro|The PagePro Report Editor]]    Next: [[reports:items_and_stock|Items and Stock reports]]//+\\ 
 +\\ 
 +|  //  Previous:  **[[reports:report_templates]]** | | Next: **[[reports:pagepro]]** //  |
 ---- struct data ---- ---- struct data ----
 +pagestatus.status    : 
 ---- ----
  
  • Last modified: 2019/09/04 15:17
  • by lou