View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Add page
Show collection (0 pages)
Collections help

Search

Modules:IDL Development User Manual

Contents

Preface

About this user manual

This Initial Data Load user manual explains how to collect data from a legacy system or other sources, and import this data into Openbravo ERP using the load process defined for the main entities used in Openbravo ERP. These load process are intended to build from a fresh Openbravo ERP installation, a fully functional information system ready to start with all the operation activities and ready to execute all the available reports based on the data imported.

Core features

The Initial Data Load functionality currently covers the following load process.

Getting started

Installing Openbravo ERP

The first step is to Install Openbravo ERP. There are different approaches to install Openbravo ERP that depend on the infrastructure you are using to install Openbravo ERP and the requirements needed.

The Openbravo ERP Installation guide explains all the requirements and steps to follow to sucessfully install and configure Openbravo ERP in your environment.

Installing the Initial Data Load module

After installing Openbravo ERP, the next step is to install the 'Initial Data Load Module'. Access Openbravo ERP through a web browser and as System Administrator go to 'General Setup -> Application -> Module Management'. In this window go to the 'Add Modules' tab and select to install the 'Initial Data Load' module. Perform all the steps needed to finish the installation. After the installation is done you will have access to all the load processes available.

A detailed guide how to install a new module can be found in the Install Module video.

Initial Data Load module

Create Client Entity and Organization

The next step after installing the module is to create the initial client-entity and an organization. Each client-entity is a company managed by the application and each organization is a business unit within an entity. If you are going to import entities that require accounting or you will use the accounting functionality of Openbravo ERP be sure to create the Organization with accounting support.

The entities that require accounting are:

All the details to create the initial client-entity and an organization are explained in the General Setup document.

Change to the role used to execute the import process

After the client-entity and the organization has been created you must change to the role corresponding to the client-entity just created. This role will be used to import all entities.

Defining data be imported

Collecting data

All data to be imported must be collected from the legacy management system or other sources and stored to a flat text file with CSV format. Most popular tools like [Excel] or [OpenOffice.org Spread Sheets] have an option to export data to this format.

Each entity to be imported must be defined in one CSV file and each CSV file defined for each entity requires to define a list of fields. The first line of all CSV data files must contain the definition of the fields required for the entity the CSV data file refers to. Each next line contains the field values for one record. Field values must be separated with a comma. And the format for each field is the following:

This is an example of a CSV created to import Products:

"Organization","Search key","Name","Description","UPC/EAN ","Product category ","UOM","Product type ","Production","BillofMaterial","Discontinued","CostType","AttributeSet","AttributeSetValue","Stocked","Purchase","Sale","Tax category ","Standard cost ","Price - Sales ","Price - Purchase "
"","rma","Raw material A","Raw material for purchase",3344567,"Raw material","Bg","Item","False","False","FALSE","Average","Serial Number",,"True","True","False","IVA 4%",,,2.5
"","rmb","Raw material B","Raw material for purchase",3344534,"Raw material","Bg","Item","False","False","FALSE","Average","Serial Number",,"True","True","False","IVA 4%",,,3.5
"","rmc","Raw material C","Raw material for purchase",3344523,"Raw material","Bg","Item","False","False","FALSE","Average","Serial Number",,"True","True","False","IVA 4%",,,4.5
"","fga","Final good A","Final goods for selling",3344567,"Final goods","Kg","Item","False","False","FALSE","Average","Lots",,"True","False","True","IVA 16%",,15.5,
"","fgb","Final good B","Final goods for selling",3344567,"Final goods","Kg","Item","False","False","FALSE","Average","Lots",,"True","False","True","IVA 16%",,15.5,
"","fgc","Final good C","Final goods for selling",3344567,"Final goods","Kg","Item","False","False","FALSE","Average","Lots",,"True","False","True","IVA 16%",,15.5,
"","sva","Service A","Consultant services",3344567,"Services","HR","Service","False","False","FALSE","","",,"False","False","True","IVA 16%",,15.5,
"","svb","Service B","Consultant services",3344567,"Services","HR","Service","False","False","FALSE","","",,"False","False","True","IVA 16%",,15.5,

The definition of the fields required and a sample CSV file for each load process and a sample CSV file are listed in the following links:

Defining default values

Depending on the data needed to import there can be values in every Openbravo ERP entity that are the same for all the records that are going to be imported. In this case, to avoid to duplicate the same value for a field in the CSV data file, there is a defaulting mechanism that allows to define default values for all records.

This window can be accessed going to 'Master Data Management -> Initial Data Load -> Setup -> Entities'. In this window, in the 'Entities' tab first select the entity, then go to the 'Fields' tab and define the default values for the required fields.

If you want to define the same default value for a field across all entities, select in the 'Entities' tab the value '*', then go to the 'Fields' tab and define the default value selected. This default value will be used in all entities but if there is defined a default value for the same field in a concrete entity, this last default value will be used.

File:Idl-defaultwindow.png
Initial Data Load Window for entities definition

For example in the CSV data file used to import Products there exists a mandatory field called 'Tax Category'. If all products you are about to import belong to the same Tax Category, for example 'VAT 16%' then it is not necessary to set this value for all rows in the Products CSV data file. Just go to the Entities window, select the 'Products' entity in the 'Entities' tab, select 'Tax Category' in the 'Fields' tab and write 'VAT 16%' in the 'Default Value' field.

Executing the load process

Execution Order

The available process define entities that have dependencies between them, for this reason, if you are going to import data for more than one entity, it is required to follow one order that entities that have other entities that depend on it, are imported before.

The recommended order to follow to import the available entities is:

Previous data prior to import

Depending on the entity data to be imported, there is required to perform some preparation steps in order to import successfully the data. These preparation steps usually consist in the creation some basic entities and execution of processes that will be used by the process that actually imports the data entities into the Openbravo ERP system. In order to be able to import the sample csv provided in this section please follow the following step:

Common previous data

These are the common steps previous to import the sample csv files

Previous data and steps for each entity process available

Products

All the details to create Products are explained in the Setting up products document.

Price Lists

No preparation steps are required. If needed all the details to create Price Lists are explained in the Pricing document.

Bank Accounts

All details to perform these preparation steps required to create Bank Accounts are explained in the Setting up accounting document.

Business Partners

If needed, all the details to create Business partners are explained in the Business partners document.

Open Receivables and Open Payables

If needed, all the details to create Open Receivables or Open Payables are explained in the Receivables and Payables document.

Assets

No preparation steps are required. If needed all the details to create Assets are explained in the Assets document.

Journal Entries

No preparation steps are required.

Standard Cost

No preparation steps are required. If needed all the details to manage Costings are explained in the Setting up products document

On hand quantity / Stock

No preparation steps are required. If needed all the details for Warehouse Management are explained in the Warehouse Management document.

Validating input data quality and Importing data

After the data has been collected and default values are defined, the load process can be executed. The process window can be accessed going to 'Master Data Management -> Initial Data Load -> Process -> Import'. Here you have to select the entity data process to import and the CSV file with the the data corresponding with the selected entity.

There are two process available.

This process validates the correctness of the data contained in the CSV file, it reads all rows in the CSV data file and verifies that the data values are correct. It checks data types, mandatory fields and that fields that have a relationship with other tables, this relationship exists, for example fields like 'Country', 'Region' and 'Tax Category'.

Before executing the 'Process' process is recommended to run first the 'Validate' process, and when all errors that appear running the 'Validate' process has been fixed execute the 'Process' process that actually imports the entities.

If any of the rows is rejected the process continues after all rows have been read.

This process first reads all rows in the CSV data file and verifies that the data values are correct, the same task done by the 'Validate' process and after all the data values of a row have been verified, the data is loaded into the Openbravo ERP information system.

If any of the rows is rejected the process stops and marks the rest of rows as 'not processed'. This way if a row is rejected you can edit the original CSV file, find the row that has been rejected, remove the previous rows because all of them have been successfully loaded, fix the error, save the CSV file, and start with the load process again.

Verifying process results

At the end of the execution of the process it will be displayed the total of rows read, and the number of rows processed, not processed and rejected.

The result of the execution of any of the two process, 'Validate' or 'Process' can be 'Success' or 'Error'. The result is 'Success' if all rows have been processed successfully and is 'Fail' if any of the rows has been rejected, because it does not pass any of the validation checks in the 'Validate' process or because it cannot be imported into the system in the 'Process' process.

For all rows that has been rejected it will be displayed in the first log panel the row with the values rejected and the cause of the rejection, and if the cause of the rejection has been a java exception, in the second log panel, it will be displayed the full java stack traces that were the cause of the row rejection.

File:Idl-processwindow.png
Initial Data Load Process Window

Final steps

Verifying imported data

After all required import process has been executed the Openbravo ERP system is ready to start transactions and execute reports based on imported data, but it is important to perform some tests to verify that all the imported data required has been correctly created and the state of the full Openbravo ERP system is consistent.

Depending on the entity process that has been executed these are the recommended actions to validate the data imported:

Bank Accounts

Open Receivables and Open Payables

Retrieved from "http://wiki.openbravo.com/wiki/Modules:IDL_Development_User_Manual"

This page has been accessed 240 times. This page was last modified on 11 January 2019, at 11:43. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.