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

PDF Books
Show collection (0 pages)
Collections help

Search

Projects:Copy Retail Store and Terminal

Commercial Extension Module (zero cost) Copy Retail Store and Terminal is an optional free commercial module that can be installed on top of Openbravo for Retail distribution starting from RR14Q2.

Contents

Overview

It provides an easy way to:

Copy Store

Copy-store.png

The process is named Copy Retail Store. It can be opened from the Quick Launch OB3 QuickLaunch.png icon.

Defaults Configuration

Copy-store-defaults.png

Some of the default values required during the Copy Store process are defined in the Copy Store Parameterization window.

Further explanation on what they are used for can be found in Terminal Type and Terminal Type - Payment Method sections.

Process Execution

After filling the parameters and clicking on the Done button the process is executed.

Here is a description of the different steps it does.

Default behavior

This process copies several entities from existent ones. The default behavior during the copy is:

This default behavior is overwritten by the process for some specific properties. Note it is also possible to extend this process through external modules to define different behavior for any property.

Copy Store (Organization)

The Store selected in Store To Copy parameter is copied to a new one.

The properties with different behavior than the standard one are:

Price List

In case Price List parameter is set, it will be used for the new Store. If not, a new one will be created with these values:

Bulbgraph.png   Note when a new Price List is created, it only contains header but not any version nor products.

The rest of parameters are copied from the Price List linked from the Store to Copy.

Assortment

The assortment used in the new store can be defined by the Assortment parameter. If it is not defined, a new one will be created.

Bulbgraph.png   Note the new Assortment will not contain any product by default
.

Its properties will be:

Anonymous Customer

In case the Anonymous Customer parameter is not blank, it will be used. Other case, a new one will be created based on original store's anonymous customer with the following properties:

Warehouse

A new warehouse with a single bin is created and assigned to the new store.

Financial Accounts

All Financial Accounts defined in original store are copied to the new one

The properties with exceptional behavior are:

Payment Methods

All Payment Methods in the original Financial Accounts are copied to the new ones.

Cash Management Events

All Cash Management Event in the original store are copied to the new one.

With the following values:

POS Terminal

There are two ways to copy terminals:

The following fields are filled for the default process.

POS Terminal - Payment Type

All payment types in the original POS Terminals are copied to the new ones

Terminal Type

Default values used to perform this part of the process are defined in Copy Store Parameterization window.

When copying terminal, the terminal type is reused in case the original one is also in the new store's organization tree; if it is not a new one is created as a copy of the original one.

Terminal Type - Payment Method

Access

Access to new store is granted to all Automatic Roles.

Additionally roles with only access to original Store are copied but they are not assigned to any user.

Copy from file

Some of the parameters (POS Terminal, User, User Roles) can be generated from a file instead of take the data from the store to copy.

The file should be upload in the new field added on Copy Retail Store process definition. Mandatory fields for Openbravo will be mandatory too on the file.

For each column it is searched for Column Handlers to be executed. If there are more than one handler it will be executed the handler with the lowest priority. In case that a column has not any handler, the process will notify with an information log and it will only be processed by a generic handler if:

Excel file

To copy an organization from an excel file it is needed the following module:

The file is formed by sheets. The sheets have columns to be processed. The column names have filled in the first row of the excel file. The column names that they have not a specific implementation, are made by the Column Name DB or the Property Name. However, if no specific implementation exists for a column, the name for this column can be different.

Implemented sheets must be defined on 'Copy Store Configuration' window as system admin. Implemented sheets for excel files are:

It is important the order of the sheets for the correct functionality of the process. As they are defined above is the best order of the sheets.

POS Terminal

In order to copy POS terminals from an excel file, it is needed to create a new record in Copy Store Configuration Window as system admin with the following data:

For each POS terminal added into the Terminals sheet, it should be at least defined:

The POS Terminal Process will copy each column in its respective openbravo column for each terminal. Also, it will copy all payments types related to the original POS Terminal as the default process. In case there are more than one POS Terminal with the same terminal type in the store copied, it will get the first result.

User

In order to copy the users from an excel, it is needed to create a new configuration in Copy store Configuration window as system admin with the following data:

The following columns will be at least defined and will be filled for each user on Users sheet:

User Role

In order to assign roles to a user from an excel, it is needed to create a new record in Copy store Configuration window as system admin with the following data:

User Roles will be the sheet where will be at least defined the columns with the users and roles related to the previous users:

It is mandatory for each row that both columns exist to process it.

User Terminal

In order to assign terminal access to a user from an excel, it is needed to create a new record on Copy store Configuration window as system admin with the following data:

The columns defined at least in User Terminals sheet for each user should be:

It is mandatory for each row that both columns exist to process it.

Hardware Manager

In order to copy the Hardware Managers from an excel, it is needed to create a new configuration on Copy store Configuration window as system admin with the following data:

All hardware managers it is wanted to create for the new store should be on Backup Printers sheet. The following columns should be at least defined:

Backup Printers Process creates first a new Hardware Manager for the new organization. Once it is created, it will be assigned to the terminal type specified. In case there are more than one terminal type with the same name it is chosen the first.

Copy Terminal

Copy-terminal.png

Copy Terminal process is executed from POS Terminal window.

To execute it, select the terminal to copy, and click on the Copy Terminal button.

The process creates a new terminal based on the selected terminal it works in the same way POS Terminal copy in Copy Store process.

Extending/Modifying the Process

Developers can extend and/or modify logic executed by these 2 processes.

Also it is possible to extend the functionality to copy from a file.

Sections defined should implement a Tab Handler. There maybe more than one handler implementing one section. In this case, it is executed the handler with the lowest priority. For each Tab Handler it is needed to overwrite two methods:

For each Column Handler it is needed to overwrite two methods:

Further information about how to do it can be found in Developers Guide for Copy Retail Store and Terminal document.

Modules extending/modifying the process

The following published modules extend or modify the original process:

Retrieved from "http://wiki.openbravo.com/wiki/Projects:Copy_Retail_Store_and_Terminal"

This page has been accessed 1,588 times. This page was last modified on 21 February 2018, at 16:32. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.