This describes a process of adding a report to the report dialog - how to actually create the report, is another story. We assume it is going to be an accounting report, but it works the same way for other modules.

Table of Contents

• Steps
  • Add an entry to the "Report select"
  • 2. Create a dialog
• Related Articles

Steps¶

Add an entry to the "Report select"¶

• Go to portal_types -> Accounting Transaction Module -> Actions.
• Add an action:
  • Name : any you wich
  • Id : unique
  • Action : like ${object_url}/AccountingTransactionModule_view<my_new_report>ReportDialog
  • Persmission : View
  • Category : object_report

this is the first report for that module a Report icon will appear on the main View form. After clicking it You will be redirected to a report dialog form. If it's a subsequent report, it will now appear in the dropdown list on the dialog form.

2. Create a dialog¶

The report dialog is an ERP5 Form - the best way is to copy one of the stock report dialogs and customize for your needs. The dialog is here so that the user can specify parameter for the report (like a section, a start date ... ).

When adding new fields, the naming convention should be used (your_field_name). This way when processing submitted REQUEST in a report or a script, it's easy to access field's values by using just field_name keys. This is especially essential when processing date values, since they are glued together from three separate fields.

An important thing is that if the report is going to be an ERP5Form printout, the dialog has to have a hidden field your_portal_skin, defaulting to Print; if the report is a ERP5 PDF Form or ERP5 PDF Template, it is not needed. Adding this field my_portal_skin will add a portal_skin key in the request, which CMF Skin Tool will use to decide which skin folder will be used.

In the dialog's settings, its Page Template has to be form_dialog, and its action is the report or the script which handles the dialog output. In the latter case the script should return the report itself.

For consistency, name the report AccountingTransactionModule_view<my_new_report>Report.

Related Articles¶

• Guidelines | A Document Form Uses The form_view Page Template
• Guidelines | Add Column Portal Type If Listbox Contains Multiple Types
• Guidelines | Add Date In Listbox As Editable Date-Time Field
• Guidelines | Add Viewable Listbox Fields To More Columns
• Guidelines | Define Count Method As countFolder On Module Listbox
• Guidelines | Define Report Actions As object_report Linked With View Permission
• Guidelines | Dialog Form Name Is Postfixed With Dialog
• Guidelines | Do Not Mix Description And Comment
• Guidelines | Do Not Test Required In Field View Form
• Guidelines | Document Content Is Written In British English
• Guidelines | Field Title Must Be Singular, Capitalized And Uses Space Separator
• Guidelines | Form Name Uses Lowercase View After Portal Type
• Form Proxification
• Guidelines | Form Report Dialog Is Postfixed With Report
• Guidelines | Forms Must Use Left, Right, Center, Bottom And Hidden Groups
• Guidelines | Hide Listbox Editable Fields On The Form
• Guidelines | Language Priority
• Guidelines | ListField Or MultListField For Categories Must Use Item List Method
• Guidelines | Listbox Must Only Be Put In Form Bottom Group
• Guidelines | Listbox Only Tabs Should Have A Read Only Title In Center Group
• Guidelines | Listbox Selection Name Must Follow module_name_selection Pattern
• Guidelines | Never Allow Relation String Fields To Set Relations To Categories
• Guidelines | Never Render Reports Directly
• Guidelines | Never Set Search Row And Select Column On Listbox Inside Document View
• Guidelines | Never Show Or Make User Work With Document Id
• Guidelines | Place Simulation And Validation Fields At Bottom Of Right Group
• Guidelines | Report Method Name Uses ReportSectionList Postfix
• Guidelines | Report Name Uses Portal Type Followed By View Report Name And Report
• Guidelines | Set Description On Form Fields
• Guidelines | Set Document Form Ids To PortalType_view
• Guidelines | Set Document Form Titles To What Is Displayed
• Guidelines | Set Form Action Base_doSelect On Forms
• Guidelines | Set Form Action To Base_edit
• Guidelines | Set Form Encytype to multipart/form-data When Using File Upload
• Guidelines | Set Form Id To ModulePortalType_viewPortalTypeList
• Guidelines | Set Form Title To What Is Displayed
• Guidelines | Set List Method To contentValues On Document Form Listbox
• Guidelines | Set Listbox Action To List Action On Document Form Listboxes
• Guidelines | Set Listbox Selection Name To form_name_selection_name
• Guidelines | Set Listbox Title To Plural Of Portal Type Title If Applicable
• Guidelines | Set Post Method And Utf-8 Encoding On Document Forms
• Guidelines | Split Large Forms On Multiple Tabs
• Guidelines | The Listbox Method Should Be Defined As SearchFolder To View Modules
• Guidelines | Use Correct Names For Simulation And Validation Titles
• Guidelines | Use form_list Page Template On Forms
• Guidelines | Use getTranslatedId To Display Document Ids In Listbox Or Form
• Guidelines | Use Method Post And UTF-8 Encoding On Forms
• Guidelines | Use Proxy Fields Of Proxy Fields In Form
• Guidelines | Use Translated Portal Type To Display Portal Type
• HowTo | Add Report
• HowTo | Configure Relationstring Field
• HowTo | Configure Parallellist Field
• HowTo | Configure Proxy Field
• HowTo | Create New Forms
• HowTo | Create OOO (Open Office) Report
• HowTo | Create PDF Report
• HowTo | Display or Edit HTML
• HowTo | Display Souce Code
• HowTo | Edit Listbox Data Source
• HowTo | Update PDF Form
• Technical Note | Web Forms