Modules:Copy Retail Store and Terminal

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 1 Overview 2 Copy Store 2.1 Defaults Configuration 2.2 Process Execution 2.2.1 Default behavior 2.2.2 Copy Store (Organization) 2.2.3 Price List 2.2.4 Assortment 2.2.5 Anonymous Customer 2.2.6 Warehouse 2.2.7 Financial Accounts 2.2.8 Payment Methods 2.2.9 Cash Management Events 2.2.10 POS Terminal 2.2.11 POS Terminal - Payment Type 2.2.12 Terminal Type 2.2.13 Terminal Type - Payment Method 2.2.14 Access 3 Copy Terminal 4 Extending/Modifying the Process

Overview

It provides an easy way to:

• Create a new Store based on an existing one.
• Create a new POS Terminal based on an existing one.

Copy Store

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

Defaults Configuration

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:

• Try to copy property from the original entity to the new one
• If the original property references to another entity that is not in the new tree of organizations, it is set as blank, in case it is mandatory the process fails

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:

• Search Key: the value is directly copied from Search Key parameter
• Name: the value is directly copied from Name parameter.
• Currency: in case the Currency parameter is set, that will value will be used in the new Store; if it is not set, the same currency the original Store had will be used in the new one.
• Location/Address: it will be set based on all the Location parameters.
• Warehouse: a new warehouse with 1 bin is created for the new Store.
• Price List: the one defined in Price List section is used.
• Assortment: the one defined in Assortment section is used.
• Anonymous Customer: the one defined in Anonymous Customer section is used.
• Default BP Category for BPs: the same category as the selected Anonymous Customer.
• Default BP County for BPs: taken from Country parameter.
• Templates in Web POS Formats section are all set as blank.

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:

• Organization: it will be in the new Store/Organization.
• Name: its default name will be "New Store Search Key - Sales Price List".
• Currency: if the Currency Parameter is set, it will be used. If not, the same currency that the original Store's price list had will be set.

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.

.

Its properties will be:

• Organization: it will be in the new Store/Organization.
• Name: "New Store Search Key - Assortment".

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:

• Organization: it will be in the new Store/Organization
• Name and Search Key: "New Store Search Key - Anonymous Customer".
• Business Partner Category: it will be taken from Business Partner Category parameter. Note this parameter is mandatory is Anonymous Customer parameter blank.
• Location: a new location will be created for the the Anonymous Customer based on Location parameters. Note that even Anonymous Customer parameter this new location will be added to the selected Business Partner.

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:

• Currency: in case the Currency parameter is set, that value will be used in the new Financial Account; if it is not set, the same currency the original Financial Account has will be used in the new one.
• Description: blank.
• Location/Address: blank.
• Business Partner: blank.
• Initial Balance: 0.
• Bank Account fields: blank.

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:

• Currency: in case the Currency parameter is set, that value will be used in the new Cash Management Event; if it is not set, the same currency the original Cash Management Event has will be used in the new one.
• Payment Method: if the original one is in the new store's organization tree, it is reused; if not, the corresponding one created for the Financial Account copy will be used.
• Financial Account: Use the one created as a copy from the original one.

POS Terminal

All the terminals present in the original store are copied to the new one.

• Search Key: It looks if the original terminal search key looks like [abc]-[xyz] where there are 2 strings sparated by an hyphen (-). If this is the case [abc] is replaced with the Search Key parameter and -[xyz] is preserved in the new one. When the original search key has not this format the new search key will be SearchKey-[uvw] where [uvw] is a sequence number starting with 001.
• Name': The same value as the generated search key.
• Order Document No Prefix: The same value as the generated search key.
• Order Quotation No Prefix: The same value as the generated search key appended with QT.
• Hardware URL: blank.
• Scale URL: blank.

POS Terminal - Payment Type

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

• Financial Account: using the one previously copied.
• Payment Method: using the one previously copied.
• Cash Up Event: using the one previously copied.

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.

• Document Type: if the original one is in the new store's organization tree, it is reused; if not Document Type defined in the selected Defaults parameter is used.
• Document Type for Returns: if the original one is in the new store's organization tree, it is reused; if not Document type for Returns defined in the selected Defaults parameter is used.
• Document Type for Reconciliations: if the original one is in the new store's organization tree, it is reused; if not Document type for Reconciliations defined in the selected Defaults parameter is used.

Terminal Type - Payment Method

• Payment Method: the one copied in Payment Method step is used.
• Currency: in case the Currency parameter is set, that value will be used; if it is not set, the same currency the original Payment Method has will be used in the new one.
• Document Type: if the original one is in the new store's organization tree, it is reused; if not Payment Method Document Type defined in the selected Defaults parameter is used.
• G/L Item for Writeoff: if the original one is in the new store's organization tree, it is reused; if not G/L Item for Writeoff defined in the selected Defaults parameter is used.
• Cash Differences: if the original one is in the new store's organization tree, it is reused; if not Cash Differences defined in the selected Defaults parameter is used.
• G/L Item for Withdrawals: if the original one is in the new store's organization tree, it is reused; if not G/L Item for Withdrawals defined in the selected Defaults parameter is used.
• G/L Item for Deposits: if the original one is set and it is in the new store's organization tree, it is reused; if not G/L Item for Deposits defined in the selected Defaults parameter is used.
• G/L Item for Cash Drop/Deposit: if the original one is set and it is in the new store's organization tree, it is reused; if not G/L Item for Cash Drop/Deposit defined in the selected Defaults parameter is used.

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 Terminal

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.

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

Category: Retail