OpenRPT Product Guide

A PDF of the OpenRPT Product Guide is available for purchase.

Using the Standalone and Embedded Versions of the xTuple Report Writer

Version 2.0.0

March 2009


Table of Contents

Introduction
1. What is OpenRPT?
2. What Platforms Does OpenRPT Run On?
1. Report Writer Basics
1. xTuple Report Writer
2. OpenRPT
3. The Toolbar
3.1. New File
3.2. Open File
3.3. Save File
3.4. Cut
3.5. Copy
3.6. Paste
3.7. Show Grid
3.8. Snap to Grid
3.9. Labels
3.10. Fields
3.11. Text Areas
3.12. Lines
3.13. Bar Codes
3.14. Images
3.15. Graph Editor
4. Managing Report Definitions
4.1. Loading Reports from a Database
4.2. Saving to XML
4.3. Loading from XML
4.4. Saving to a Database
5. Parts of a Report Definition
5.1. Section Editor
5.2. Report Headers
5.3. Page Headers
5.4. Report Footers
5.5. Page Footers
5.6. Detail Sections
5.7. Group Sections
2. Getting Started
1. Modifying an Existing Report
1.1. Query Sources Overview
1.2. Editing Labels
1.3. Editing Fields
1.4. Adding Bar Codes
2. Column Headings
2.1. Modifying Column Headings
2.2. Adding Column Headings
3. Modifying Query Sources
3.1. Editing SQL Statements
3.2. Retrieving Data
4. Total Fields
4.1. Adding Horizontal Lines
5. Counter Fields
3. Advanced Topics
1. MetaSQL
1.1. MetaSQL in Practice
1.2. MetaSQL Syntax
1.2.1. Control Statements
1.2.2. Functions
2. MetaSQL Editor
2.1. Connecting to a Database
2.2. Entering a Query
2.3. Defining Parameters and Values
2.4. Parsing and Executing a Query
2.5. Resulting Standard SQL
3. Report Renderer
3.1. Connecting to a Database
3.2. Ad Hoc Reports
3.3. Loading Report Definitions
3.4. Adding OpenRPT Renderer Runtime Parameters
3.4.1. Define Parameter
3.4.2. Set Parameter Value
3.4.3. Changing Parameter Values
3.4.4. Deleting a Parameter
3.4.5. Generating the Ad Hoc Report
4. Watermarks and Background Images
4.1. Background Images
4.1.1. General
4.1.2. Layout
4.1.3. Static Image
4.2. Watermarks
5. Bar Coding
6. Graphing
6.1. Graphical Report Output
6.2. Graphical Report Definition
6.2.1. Query Source
6.2.2. Color Definitions
6.3. Defining the Graphing Object
6.3.1. Graph Editor General Tab
6.3.2. Graph Editor Data Axis Tab
6.3.3. Graph Editor Value Tab
6.3.4. Graph Editor Series Tab
4. OpenRPT and ODBC
1. The Access Database
2. Sample ODBC Connection
3. Creating the Report’s SQL with the MetaSQL Editor
3.1. Connecting Through the ODBC Driver
3.2. MetaSQL Parameters
3.3. The Query
4. Report Definition
4.1. Report Properties
4.2. Creating the Query Source
4.3. Establishing Report Sections
4.4. Defining Parameters
4.5. Saving the Report’s XML Definition File
5. Generating Reports with RPTRender
5.1. Connecting Through ODBC to the Database
5.2. Opening the XML Report Definition
5.3. Setting Parameters at Run Time
5.4. RPTRender Run Time Switches
5. xTuple ERP Topics
1. Labels and Forms
1.1. Linking a Form Name to a Report Definition and Customer
1.2. Linking a Label to a Name and Report Definition
1.3. Label and Form Parameters
1.3.1. Print Packing List
1.3.2. Print Shipping Form
1.3.3. Print Shipping Forms
1.3.4. Print Shipping Labels by S/O #
1.3.5. Print Shipping Labels by Invoice
1.3.6. Print Receiving Labels by PO #
1.4. Report Definition for Custom Labels
1.4.1. Generating a Label Sheet
1.4.2. Label Report Definition
1.5. Report Definition Page Setup
1.5.1. Displaying a Parameter Value
1.5.2. Label Report Query Definition
1.5.3. Linking Label Name to Report Definition
2. Report Importing Tools
2.1. importrptgui
2.2. importrpt
6. Tools
1. pgAdmin III
1.1. Where Can I Find pgAdmin III?
1.2. Connecting to an xTuple Database
2. What is ODBC?
2.1. Locating the ODBC Driver For PostgreSQL
2.2. Configuring an ODBC Connection to xTuple
3. Capturing SQL with MS Query
3.1. What is MS Query?
3.2. Using Predefined Queries in OpenRPT

List of Tables

5.1. Parameters passed to the Packing List report
5.2. Parameters passed to the Shipping Forms reports
5.3. Field descriptions for Printing Shipping Forms
5.4. Screen Literals for Printing Sales Order Labels
5.5. Screen Literals for Printing Invoice Labels
5.6. Screen Literals for Printing Receiving Labels
5.7. Tables Used in FROM Section
5.8. Options Available to importrpt