Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated formatting, replaced all content for 2.1

General Description

This screen is used to download, alter, and upload custom reports and labels.

Screenshots

Gliffy
nameReportSearch

Search Results

 

NumberNameDescription
1LaboratoryEnter the laboratory name you wish to search for.
2NameEnter the Report name you wish to search for.
3Report TypeSelect the report type you wish to search for here (e.g. Accession Report, Working List Specimen Label, etc.).
4Search Results AreaThe results of your search show here. When you first open this screen, all results are populated here.
5Add ButtonClick here if you wish to add a new report to the database.
6Populate Templates ButtonPuts all the system templates in place. An admin must press this button once for each lab after a fresh install/migration. (Pressing it multiple times doesn't hurt; it doesn't add the templates multiple times)

 

Edit Form

Note

Some of the fields in the screen shot below only show up if you select certain types of results.

 

Gliffy
nameReportEdit

 

NumberNameDescription
1PreviewPreviews the report.
2Report NameEnter a custom name for your report
3Header Image FileAllows for uploading of headers that will display at the top of various report types. Headers should have a width around 555 pixels.
4Report TypeDesignate a specific report type for the given report (e.g. Accession Report, Working List Specimen Label, etc.).
5Data SourceThis field is used to specify which Data Source you would like your results to pull from. (e.g. SQL or JavaBean)
6Jasper FilesThis field allows for you to upload/download your .jrxml and .jasper files for your report. Steps on how to setup a custom template shown below.
7Report ParametersNote: The add/edit/move/delete functions are only available if the data source SQL is chosen.
8Sub ReportsThis field allows you to add/upload multiple reports previously generated.

How to setup a custom template

Step one - Download and install the free program iReport - http://jasperforge.org/projects/ireport.

Step two - Download one of VetView's Built-In Labels (or letters) by clicking on the Download link beside the name.  The downloaded file will be an uncompiled jrXML report file.

Step three - Open the downloaded jrXML file inside of iReport and make the desired modifications.

Step four - Compile, name, and save the new jrXML file inside iReport so it becomes a .jasper file.

Step five - Go back to the Label/Report Setup tab and click on the Upload Template button.  Choose the newly created file.  If set as the default, the new file will be printed in the appropriate sections of VetView.  

 

 

 

Note

You can delete customized/uploaded labels, but can never delete the Built-In Labels/Letters.

...


Panel


Panel
borderColorgreen
bgColor#ACF5D2
borderWidth1
borderStylesolid

Labs Report Setup

Report Setup in VetView is the screen where you can interact with Jasper reports.  You can view and adjust settings on the built in system reports, and add new custom local reports with Jasper files that pull in data using Java beans or SQL queries.  

Report Search

At the top of this screen is a search tool to help you find specific reports.  After clicking on Search, reports that match the selected criteria will display in the Report List.

Image Added

FieldDescription
LaboratoryDisplays only reports associated with this specific lab.
NameSearches for reports based on a text string match in the report name. 
Report TypeDisplays only reports of the specific report type.  All local reports are included under the type Local Report.
SystemLimits the results to either only System reports, or includes optional custom reports.
DefaultLimits the results to only default reports, or includes all reports that match the rest of the criteria.
ActiveLimits the results to only active reports, inactive reports, or both.

Report List

When this screen first loads, all the reports in the system will be displayed in this list.  After clicking on Search, the criteria will be narrowed to whatever you selected as a match.

Anchor
KNOWN BUG LIMS-10238
KNOWN BUG LIMS-10238


(minus)  (Image to be added when localization is fixed)

Add New Report

Click on the Add button to add a new report. 

Image Added

The first panel of the Report Details screen will load.  You must select the lab, enter a report name, select the report type, data source, and printer type, and then click on the Save button, before the rest of the report details can be added.   (After selecting the Report Type, the other two fields may automatically fill in.)

Image Added

Populate Templates

This function should be used on a fresh installation or import of the VetView database, to ensure that all the report templates are linked in the background. 

Report Details

After you have saved at least once, or if you open up an existing report from the list by clicking on the report name, the rest of the report details will open.

Jasper Files

These are the JRXML and Jasper template files,  You can have separate templates for PDF formatting and Excel formatting.

Image Added

Sub Reports

Sub Reports can be used to build up a larger report using smaller pieces.  This way, if you only need to make changes to one piece, you don't have to modify an entire report/

Image Added

Add New Sub Report

Click on the Add button to add a new sub report.  Give the sub report a name, and then upload the appropriate Jasper files.

Image Added

Report Parameters

Certain Local Reports will allow you to add adjustable Report Parameters.   These parameters must be added for the report to function correctly.  On the Local Report screen, the user will be prompted to enter this information as well.

Image Added

Add New Report Parameter

Click on the Add button to add a new report parameter.  A small window will appear.

Select the type, and give it a label and name, and a default value when appropriate.  Then click on the Save button to add the parameter.

Image Added

Report Images

Report images can be added to the report after they are uploaded on the Report Images Tab (see next section.)  These reports should be pulled in by the Jasper template automatically based on name.  Images can be modified on the Report Images Tab without having to manually update the Jasper files.

Image Added

Report Images

Images that you want to have accessible to multiple reports (such as a lab or organization logo) can be added once on the Report Images Tab and then added to the reports using the Report Images section.  When the file on Report Images is modified, any reports will start using the newer version, making it easy to update branding if the organization's logo changes in the future.

A preview of the file will appear when you click on the row with the file name, allowing you to verify you are looking at the correct image.

Image Added

Add New Image

Click on the Add button to add a new image.  Your local system dialog box will appear to upload the image.

Replace an Existing Image

Select the row for the image you want to replace, and click on the Edit icon.  The local system dialog box will appear to upload the new image.

Delete an Image

If an image will no longer be used, you can delete it from the system.  Note that you must have removed it from all reports that are linked to the file before it can be deleted.

A list of all linked reports appears in the bottom of this tab.  Click on the report name to jump Report Details and remove the link from Report Images. 

Image Added


Insert excerpt
Setup & Admin Guides
Setup & Admin Guides
nopaneltrue

Table of Contents