From Fishbowl Inventory

[edit] Using ireports for Custom Reports

These are the conventions accepted by Fishbowl for JasperReports. Using these conventions ensures that a custom report will be handled as expected and as desired.

Report basics

• The root report directory is Fishbowl/Server/reports. Custom reports added to this folder or any subdirectory within this folder will be used by Fishbowl.
       - The hierarchy/organization of reports in the Report Module matches the file structure of Fishbowl/Server/reports. For example, if a folder named Customer exists in the reports directory, then there will be a Customer folder in the Report Module. Any reports within that folder will appear in the matching folder of Report Module.
  
  

• Reports are keyed on path. This means that Fishbowl recognizes a report by where it is physically stored. If a report is moved, then Fishbowl assumes that it is a new report. If a report is copied over an old report, Fishbowl assumes that it is the same report, but that it has been modified and will update all relevant settings.
• Reports are Case Sensitive. This means that "FISHBOWL" is not the same as "Fishbowl".
• A report must be compiled (.jasper) in order for it to be accessible within Fishbowl.
• When you add or modify reports in the reports directory, then you must refresh the reports or the changes won't be available in Fishbowl. Open the Report Module. Go to the menu Tools | Module Options.... Run Refresh. Additionally, in order to see the changes all the clients need to be logged out and logged back in. This is also the way to change or undo the effects of Fishbowl parameters. Change the report, compile it and refresh the reports. Once the clients log back in they will be able to see the change.
  
• If there are parse errors, then the server log should be checked. Misconfigured Fishbowl parameters are a common problem. For example, it may be that one of the listed module names or additional node paths isn't correct, or an additional node path might conflict with another path. These problems will need to be corrected in the reports.
• Deleting or moving a report from reports directory will remove any record of it from Fishbowl.
  
  

Report conventions

• Name the report using camelback convention.- Camelback convention is joining multiple words together and capitalizing the first letter of each individual word, i.e. CamelBackConvention. Fishbowl goes through and puts in spaces before every capital letter to make it display properly, i.e. Camel Back Convention. Do this via the Project | Project Options dialog. DO NOT include the word "Report" in the name of the report. It's redundant.
  
• Name the file the same name as the report name used above.
  
• Don't include a date range in the query. - For reports showing date fields, don't include a date range in the query. Allow Fishbowl to apply the date range using its controls.
• Make the report hyperlink compatible. - Make the report hyperlink compatible if you are displaying fields which can be linked.
  
  

Fishbowl Parameters

• To access a report's parameters in iReport, go View | Report Parameters. Using the dialog that appears you can create new parameters, modify existing parameters, and delete parameters.
• All Parameters are Optional. REPORTDESCRIPTION Parameter will be the most useful, so it is Highly Recommended.
• Parameter Types

1. Special Parameters - Are used to tell Fishbowl to do something Special with the Report.
2. Standard Parameters - Are used to get Information from the User/Fishbowl into the Report. Used change display of report or added to the Query.
3. Auto Parameters - Are added (unless told not to) to the Report. These help with common features.
4. Custom Parameters - Are just like Standard Parameters except a specific Naming/Type Convention is used to help the User enter the Correct Type of Information into the Report.

• Parameter Fields

1. Parameter Name - The name of the Parameter. Some specific names will produce different Results. A list of Special/Custom Parameters follows this section. Use Camelback Convention for a better display in Fishbowl.

             -Titling - Some Parameters have the option of being Titled. This means adding on to the name of a Custom Parameter. The title can be left blank. The title will help to tell the difference if you use more then one of that type of Custom Parameter. The Title is what will display when Fishbowl ask the user to enter information. EXAMPLE:: parameter Name: partNumBOMPart will ask the user for a part number but will title it as "BOM Part" instead of the standard "Part Number"

     2.  Parameter Class Type - The Special and Custom Parameters depend on the Class Type you choose. The Parameter Default Expression also depends on the Class Type. java.lang.String is the default and mostly used.

     3.  For Prompting- All parameters (Except Special Parameters) are displayed to the user when the report is pulled. This field determines whether this parameter is Required or Optional. If all parameters for the Report are Optional then the report will not ask the user for anything and run the report using all defaults for Parameters. If there are some Required parameters (Is For Prompting checked true) then when the Report is run from the Report Module, Fishbowl will ask the user to enter those Parameters.
     4.  Default Value Expression-This is the Default value for your Parameter. This is the Value that iReports uses when testing your Reports. It is also the Value that Fishbowl puts in the Parameter (uses it for Optional Parameters, it will not add the default if the Parameter is Required. It makes the User enter the Required Information.). There are 2 types of Default Values:
           -Parameter Class Type java.lang.String - This value is surrounded in Quotes. EXAMPLE:: "This is a Default Value for a String".

                  -For many Custom Parameters, the best way for Optional Parameters is to follow this Template: [FileName] LIKE $P{Parameter} This is because an Optional Parameter will return a % to the report. EXAMPLE: part.num LIKE $P{partNum} This will allow the user to enter a Part Number or not one, and no part number is entered it will pull all parts.

           - Any other Parameter Class Type - This follows standard Java Syntax. EXAMPLE:: For a Type java.util.Date with default to Todays Date: new Date(). For a Type java.lang.Integer: new Integer(1).

     5.  Parameter Description - This Field is used by a few Custom Parameters. It houses additional Information that the Parameters needs. cb, dateRangeDefault, and sort use this Field.

• Special Parameters

1. These Parameters tell Fishbowl to treat this Report a certain way. The User using Fishbowl will never see these parameters, yet they will see the effects of them.

• Auto Parameters
    1. These Parameters do not have to be added to the Report. They are added automatically.
    2. Auto Date Range - Any Date Fields in your Query will be added to a Parameter. You can choose one of these fields and a Range to Filter your Report by these Values. See dateRangeDefault for how to Set the Default Values for this Parameter. If any dateRange1 Parameter is added or the dateRangeNone Parameter is added then the Auto Date Range will not show.
    3. Auto Sorting- Sort by the Fields in your Query. This will put all Fields from the Query into a Combo Box to be Sorted by. If any sort Parameter is added or the sortNone Parameter added then this Parameter will not show.

• Custom Parameters
    1. These Parameters will Display additional Information to help the User to input the Correct Desired Information.

Return to Support