Projects:Checkprinting/Functional Documentation

Contents 1 Document sign-off 2 Document Status 3 Overview & Justification 3.1 Purpose 3.2 Module/s Overall Information 3.3 Scope 3.4 New definitions and acronyms 4 Functional requirements 4.1 Configuration 4.1.1 Document Sequence configuration 4.1.2 Document Type configuration 4.1.3 Execution Process configuration 4.1.4 Payment Method configuration 4.1.5 Check Printing Window 4.2 User goals 5 Appendix

Document sign-off

Role	Name	Sign-off date
Design	Eduardo Argal

Document Status

Date	Author or editor	Description of change	Document status	Document version
December 15th, 2011	Eduardo Argal Guibert	Document creation & sent for review	Draft	V1

Overview & Justification

Purpose

The purpose of this document is to describe the functional specifications of a new extension module which is “Check Printing” for Advanced Payment Management (APRM).

The main purpose of this module is to enhance APRM to allow printing of checks and provide a system to browse historical data in order to be able to print a check again in case an error occurred.

Besides, this module must also support the creation of other extension modules which will implement a logic for new check printing formats.

This new feature is going to be developed and delivered as a new extension module which is going to be implemented according to the Technical Documentation which can be found here :
Check Printing Technical Documentation

Module/s Overall Information

• Module Name: org.openbravo.module.checkprinting
• Module Description: This module adds check printing support to the existing APRM functionality.
  The provided infraestructure can be easily extended to manage different check formats.
• Dataset Description: this module includes a dataset named "Check Printing Infraestructure", which creates:
  • a Document Type named "Standard Check" which will define the printing format (Report template)
  • a Payment Method named "Check"
  • and an Execution process named "Check Printing"
• License: Openbravo Commercial License
• Category : Openbravo ERP

Scope

Out of scope:

The first version of this module is not going to include the features listed below which have already been identify as feature requests.
These features which are currently out of scope will either be implemented as a new version of this module or as a new extension module (eiter community or professional).

• Feature Request Nº

New definitions and acronyms

• Check Printing: New window used to track and print checks.
• Check Printing Execution Porcess: new execution process linked to Check payment method used to generate the numbers for the checks and provide the document type (later used to define the template to be used)
• Check Printing Template: Template used to print the check. It will define the final output of the check. Multiple document types can be deployed though modules allowing user to manage different printing formats.

Functional requirements

Configuration

Prior to start using Check Printing module, some configuration is required.
The configuration basics must be provided as a reference data.

Document Sequence configuration

An Document Sequence is required in order to properly create the check numbers when they are not provided by the user.

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

• Name: CheckPrintingSequence
  
• Active: Yes
  
• Auto Numbering: Yes
  
• Increment by: 1
  

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: Yes
• Document Sequence: CheckPrintingSequence
• 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 configuration

An execution process is required in order to properly create checks when executing payments with previous payment method

Below basic "Execution Process" will be "automatically" created after applying Check Printing reference data set to the legal entity:

• Name: Check Printing
  
• Active: Yes
  
• Java Class Name: org.openbravo.checkprinting.executionprocess.CheckPrinting
  
• Parameters:
  • Document Type: One deployed through the data set which will define the printing format used for printing these checks.
    • 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.
    • Name: Check Number
    • Value: CheckNumber
    • Parameter Type: IN
    • Input Type: Text
    • Mandatory: Yes

Payment Method configuration

A payment method is required in order to easily identify the documents which may be consumed by Check Printing functionality.

Below basic "Payment Method" will be "automatically" created after applying Check Printing reference data set to the legal entity:

• Name: Check
  
• Active: Yes
  
• DEFAULTS PAYMENT IN:
  
  • Payment IN Allowed: No.
    
• DEFAULTS PAYMENT OUT:
  
  • Payment OUT Allowed: Yes.
    
  • Automatic Payment: No.
    
  • Automatic Withdrawn: No.
    
  • Execution Type: Automatic.
    
  • Execution Process: Check Printing.
    
  • Deferred: Yes.
    
  • Upon Payment Use: <NULL>.
    
  • Upon Withdrawal Use: <NULL>.
    
  • Upon Reconcialiation Use: <NULL>.
    

Above configuration indicates that the payment method can be used for OUT Payment transactions. Accounting configuration for this payment method must be done manually after applying the data set (payment / withdrawal / reconciliation).

It links the payment method to an execution process as well, therefore payments created under this payment method can be executed and be included in Check Printing window with the proper numbering information.

Afterwards this payment method must be assigned to:

• to the financial account to be used.
• to business partners as default value when required

Finally, let's remember that this module supports any other payment method configuration deployed as a module.

After creating any payment/s with the previously described payment method, those will remain Awaiting Execution. We will need an additional step to execute them in order to provide the first number for the check sequence. This can be done through Payment Execution form.

Select payments to be printed:

Click on process and enter value for parameter:

Now system will automatically create the entries in Check Printing window in status Not Printed. It will associate automatically the document type Check (which will define the printing format) and the number sequence.

Check Printing Window

There must be a new window to manage check printing.

This new window must be located at the application path:
"Financial Management // Receivables & Payables // Transactions // Check Printing"

Information in this window will be automatically fulfilled when executing payment OUT transactions which are using previous payment method

It should be possible to:

• Print: a check
• Print: multiple checks

Window will apply a first filter to just show those check which are in status Not Printed, although this filter can be removed to display all checks (Including checks in status Printed.

Printing a check or a set of check will be as simple as selecting them and clicking on print button.

The printing template is in charge as well of flagging selected checks as status Printed.

User goals

Check printing feature will allow the end user to:

1. Generate a printable form of a check, including all the details needed.
2. Provide the infrastructure required for any module to define a check printing format:
   1. a dataset with the corresponding check Document Type
   2. and the report template consumed by previous document type.

Appendix