Projects:StandardOFX/Technical Documentation
Contents |
Technical Documentation
Module Definition
A module must be created with the following parameters:
- Name: Standard OFX
- Version: 1.0.0.
- Java package: org.openbravo.module.standardOFX
- Description: This module to implement the transaction of import bank file from OFX format..
- Language: En_US
- License: Commercial
- License Text: Copyright (C) 2010 Openbravo S.L.U.Licensed under the Openbravo Commercial License version 1.0. You may obtain a copy of the License at http://www.openbravo.com/legal/OBCL10/BasicLicense.html
- Author: Openbravo S.L.U.
In the dependency tab:
- Core
- Advanced Payables and Receivables Management
Configuration
Once you installed the module, you need to add the reference data of the module to the system. For that please follow the below steps:
- Login with the credentials.
- Change the role to Openbravo Admin
- Navigate to General Setup || Enterprise || Enterprise module management || Enterprise module management.
- Place a tick mark / selection of Standard OFX module.
- Click on Ok button.
- It will show the message as Process completed successfully. Imported the reference data successfully to the system.
Implementation
The standard ofx module will insert the bank statements in the openbravo application from the ofx file.After installing the reference data user can import the bank statements. The standard ofx module is associated with the file format. Based on the user request standard ofx module will insert the bank statements in the FIN_BankStatement and FIN_BankStatementLine tables.
Tab definition
The Financial Account window has nine tabs. Imported Bank Statements and Bank Statements Lines tabs are comes under the Financial Account window.
Imported Bank Statements tab:
- Name : Imported Bank Statements
- Description: Matching bank statement with existing details.
- Table : FIN_BANKSTATEMENT
- UI Pattern : Standard.
- Child of the Account following the Payment Method tab.
Bank Statements Lines tab:
- Name : Bank Statements Lines
- Description: Adding new lines to the bank statement.
- Table : FIN_BANKSTATEMENTLINE
- UI Pattern : Standard.
- Child of the Imported Bank Statements tab.
Table Structure
FIN_Bankstatement table
FIN_Bankstatement | |||
---|---|---|---|
Column Name | Type | Length | Comments |
FIN_BANKSTATEMENT_ID | VARCHAR | 32 | The primary key of the table that must follow the table name followed by the _ID. |
AD_CLIENT_ID | VARCHAR | 32 | Indicates which client (company) the record belongs to. |
AD_ORG_ID | VARCHAR | 32 | Indicates which organization (city/department/location) within a client a record belongs to. |
ISACTIVE | CHAR | 1 | Intended for deactivating records that are not valid anymore but are referenced within the system and hence cannot be deleted. |
CREATED | DATE | Date/time of creation of a record. | |
CREATEDBY | VARCHAR | 32 | Foreign key to AD_USER indicating the user that created this record. |
UPDATED | DATE | Date/time of last update of a record. | |
UPDATEDBY | VARCHAR | 32 | Foreign key to AD_USER indicating the user that last updated this record. |
FIN_FINANCIAL_ACCOUNT_ID | VARCHAR | 32 | Foreign key to FIN_FINANCIAL_ACCOUNT indicating the account from which the payment will be made. |
DOCUMENTNO | VARCHAR | 32 | Document number for the payment. |
NAME | VARCHAR | 60 | A non-unique identifier for a record/document |
NOTES | VARCHAR | 255 | Indicates the additional information. |
C_DOCTYPE_ID | VARCHAR | 32 | Foreign key to C_DOCTYPE indicating the document type used for the transaction. . |
FILENAME | VARCHAR | 255 | Indicates the appropriate file name for the bank statement. |
IMPORTDATE | DATE | Import date of the bank file | |
STATEMENTDATE | DATE | The Statement Date field defines the date of the statement being processed. | |
FIN_RECONCILIATION_ID | VARCHAR | 32 | Reconciliation events related to the financial account |
PROCESSING | CHAR | 1 | Indicating a process is being performed on this record. |
PROCESSED | CHAR | 1 | This field is indicates that a document has been processed. |
FIN_Bankstatementline table
FIN_Bankstatementline | |||
---|---|---|---|
Column Name | Type | Length | Comments |
FIN_BANKSTATEMENTLINE_ID | VARCHAR | 32 | The primary key of the table that must follow the table name followed by the _ID. |
AD_CLIENT_ID | VARCHAR | 32 | Indicates which client (company) the record belongs to. |
AD_ORG_ID | VARCHAR | 32 | Indicates which organization (city/department/location) within a client a record belongs to. |
ISACTIVE | CHAR | 1 | Intended for deactivating records that are not valid anymore but are referenced within the system and hence cannot be deleted. |
CREATED | DATE | Date/time of creation of a record. | |
CREATEDBY | VARCHAR | 32 | Foreign key to AD_USER indicating the user that created this record. |
UPDATED | DATE | Date/time of last update of a record. | |
UPDATEDBY | VARCHAR | 32 | Foreign key to AD_USER indicating the user that last updated this record. |
FIN_BANKSTATEMENT_ID | VARCHAR | 32 | Bank statements related to a financial account |
LINE | DECIMAL | Indicates the unique line for a document. | |
BPARTNERNAME | VARCHAR | 60 | Indicates the busines partner name. |
C_BPARTNER_ID | VARCHAR | 32 | Foreign key to C_BPARTNER indicating the BPartner it relates to. |
DATETRX | DATE | The Transaction Date indicates the date of the transaction. | |
CRAMOUNT | DECIMAL | Indicates the credited amount. | |
DRAMOUNT | DECIMAL | Import the debited amount. | |
REFERENCENO | VARCHAR | 50 | The number for a specific reference. |
MATCHINGTYPE | VARCHAR | 60 | Type of matching for the given line. |
FIN_FINACC_TRANSACTION_ID | VARCHAR | 32 | Foreign key to FIN_FINACC_TRANSACTION indicating the financial transaction used in this transaction. |
EM_C43_DESCRIPTION | VARCHAR | 2000 | C43 Description. |