Projects:Checkprinting/Technical Documentation

Contents 1 Check Printing 1.1 Module Definition 2 Artifact List 2.1 Window definition 2.1.1 Check Printing window 2.2 Report & Processes 2.3 Document Type configuration 2.4 Execution Process 2.5 Data Set 3 Entity Relationship diagram 4 Database Structure definition 4.1 OBFCHP_Check_Printing table

Check Printing

Module Definition

A module must be created with the following parameters:

• Name: Check Printing
• Version: 1.0.0.
• Java package: org.openbravo.finance.checkprinting
• Description: This module adds check printing support to the existing APRM functionality.
  The provided infraestructure can be easily extended to manage different check formats.
• Language: En_US
• License: Openbravo Commercial License
• License Text: Append commercial license here
• Author: Openbravo S.L.U.

In the dependency tab:

• Dependant on Advanced Payables and Receivables version 1.0.20

In the prefix tab: Prefix=OBFCHP

In the datapackage tab: org.openbravo.finance.checkprinting

Artifact List

The development of this module involves the creation of the several items in the application dictionary. Notice that new fields, tabs and window will require of the creation of the corresponding tables and columns in the application dictionary. The relation of these new database objects is described in the Database Structure Definition section. Below is the list of windows and processes that are new or might have some changes.

Window definition

Check Printing window

• Description: Select and print checks.
• Help: Select and print checks according to your needs.

This new window has one tab called Check Printing.

Check Printing Tab:

• Name: Check Printing
• Description: Select and print checks.
• Table: OBFCHP_Check_Printing
• UI Pattern: Edit Only.

Fields included (descriptions are provisional):

• Document Type: The Document Type determines the printing format for the selected check
• Check Number: Number sequence used when printing a check.
• Check Date: Check Date, used to print the check
• Business Partner: Business partner to pay to.
• Amount: Check amount.
• Status: Check status: Printed, Not Printed.
• Payment: Payment this check is linked to.

Report & Processes

This module includes a report which will be used as Check Printing Template when printing checks.

• JR File: Rpt_Check.jrxml
  
• Java Class: Rpt_Check.java
  • Performs:
    • Check Printing: Generates an output pdf file base on JR File.
    • Updates Record: Updates Check record to move it from Not Printed to Printed

Document Type configuration

An Document Type is required in order to properly create checks when executing payments with previous payment method, to provide the template used when printing checks

Below "Document Type" will be "automatically" created after applying Check Printing reference data set to the legal entity:

• Name: Check
  
• Active: Yes
  
• G/L Category: None
  
• Print Text: Check
  
• Document Category: Check
  
• Table: To Be Defined (Check Printing Table)
  
• Sequenced Document: No
• Sales Transaction: No
• Default: Yes
  • Report Template: One deployed through the data set which will define the printing format used for printing these checks.
    • Name: Standard Check Format
    • Template Location: @basedesign@/templateLocation
    • Template File Name: Rpt_Check.jrxml
    • Report File Name: Check-@our_ref@

Execution Process

• Execution Process: Check Printing
  • Description: Process that moves a payment from Awaiting Execution to Payment Made. It as well creates an entry in OBFCHP_Check_Printing table.
  • Parameters:
    • Document Type: One deployed through the data set which will define the printing format used for printing these checks. When the entry in check printing table is created, this document type is set.
      • Name: Document Type
      • Value: C_DocTypeId
      • Parameter Type: Constant
      • Default Text Value: Document Type Id (One deployed through the data set)
      • Mandatory: Yes
    • Check Number: This parameter will be consumed to assign number to the check. When executing several at once the number will be used for first one and system will assume next are sequential. When the entry in check printing table is created, this check number/s is/are set.
      • Name: Check Number
      • Value: CheckNumber
      • Parameter Type: IN
      • Input Type: Text
      • Mandatory: Yes

Data Set

• Data Set: Check Printing
  • Description: Inserts Payment Method and Execution Process with its Parameters. It as well provides a Document Type which will be used as a parameter of the execution process. This document type is linked to Check Printing Template.

Entity Relationship diagram

[Not Yet Available]

Database Structure definition

Relation of tables and triggers that needs to be included in the module.

OBFCHP_Check_Printing table

OBFCHP_Check_Printing
Column Name	Name	Reference	Length	Description
AD_Client_ID	Client	TableDir	32	Client for this installation.
AD_Org_ID	Organization	TableDir	32	Organizational entity within client
Created	Creation Date	DateTime	19	The date that this record is completed.
Createdby	Created By	Search	32	User who created this records
Isactive	Active	YesNo	1	A flag indicating whether this record is available for use or de-activated.
Updated	Updated	DateTime	19	x not implemented
Updatedby	Updated By	Search	32	User who updated this records
OBFCHP_Check_Printing_ID	Check Printing	ID	32	ID of the table.
C_DocType_ID	Document type	Table Dir	32	Check Printing Document Type. Determines which is the template used for printing
CheckNumber	Check Number	Character Varying	60	Number used by the check when printing
CheckDate	Check Date	DateTime	19	The date that this Check is created.
FIN_Payment_ID	Payment	TableDir	32	It is the payment this check is related to.
C_BPartner_ID	Business Partner	TableDir	32	Business Partner to pay to.
Amount	Amount	Amount	22	Amount to be paid.
Status	Status	List	60	Status of the check (Not Printed, Printed).
due_date	Due Date	DateTime	19	The due date of the Payment.