Difference between revisions of "Module CashdeskPar EN"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
  
 
²<!-- You can edit this section but do NOT remove these comments
 
²<!-- You can edit this section but do NOT remove these comments
Line 30: Line 29:
 
CashdeskPar is the first module to offer an improvement of Dolibarr's original point of sale. It was developed in 2014 on the version 3.1 of Dolibarr. Since then, it has gathered many new features to configure through its thirty parameters.
 
CashdeskPar is the first module to offer an improvement of Dolibarr's original point of sale. It was developed in 2014 on the version 3.1 of Dolibarr. Since then, it has gathered many new features to configure through its thirty parameters.
  
= Installation =
+
=Installation=
  
* Download the module archive file (.zip) from the www.dolistore.com website or retrieve it in any other way.
+
*Download the module archive file (.zip) from the www.dolistore.com website or retrieve it in any other way.
* Put the file in the root directory of dolibarr or create a custom folder at the root of Dolibarr to place it with all your additional modules (If you choose this solution, remember to uncomment the two lines of the conf file)
+
*Put the file in the root directory of dolibarr or create a custom folder at the root of Dolibarr to place it with all your additional modules (If you choose this solution, remember to uncomment the two lines of the conf file)
* Unzip the file with the command unzip module_Cashdeskpar-X.Y.Z.zip
+
*Unzip the file with the command unzip module_Cashdeskpar-X.Y.Z.zip
* The correct location of the module must be of the type: htdocs/custom /cashdeskpar.
+
*The correct location of the module must be of the type: htdocs/custom /cashdeskpar.
* Go to the installation location of the module and give read and write privileges to the PHP server for the following files:
+
*Go to the installation location of the module and give read and write privileges to the PHP server for the following files:
  
# cashdeskpar_consts.php
+
#cashdeskpar_consts.php
# cashdeskpar_default_consts.php
+
#cashdeskpar_default_consts.php
  
 
The module is operational and may be activated.
 
The module is operational and may be activated.
  
= Configuration =
+
=Configuration=
 
To use this module, you must first activate it. To do this, after logging in with an administrator account, go to  " '''Home - Configuration - Modules''' " page. The module appears in "Produc /Service Management (PM)", click "Activate". A pictogram appears at the end of the line of the module, click on it to access the setup page specific to this module:
 
To use this module, you must first activate it. To do this, after logging in with an administrator account, go to  " '''Home - Configuration - Modules''' " page. The module appears in "Produc /Service Management (PM)", click "Activate". A pictogram appears at the end of the line of the module, click on it to access the setup page specific to this module:
 
[[File:Capture d’écran de 2019-12-04 12-36-10.png|none|thumb|1300x1300px|CashdeskPar setup Page]]
 
[[File:Capture d’écran de 2019-12-04 12-36-10.png|none|thumb|1300x1300px|CashdeskPar setup Page]]
 
The setup page consists of two parts:
 
The setup page consists of two parts:
  
# The upper part is identical to that of Dolibarr's point-of-sale module.
+
#The upper part is identical to that of Dolibarr's point-of-sale module.
# The lower part contains the '''CashdeskPar-''' specific parameterizing section ''',''' which itself consists of two sub-sections:
+
#The lower part contains the '''CashdeskPar-''' specific parameterizing section ''',''' which itself consists of two sub-sections:
## Parameters subsection: This section contains all the parameters that change the behavior of the module. It consists of two foldable titles that separate the parameters into two categories. The product parameters include all the features that characterize the product selection while the first category contains all the rest of parameters.
+
##Parameters subsection: This section contains all the parameters that change the behavior of the module. It consists of two foldable titles that separate the parameters into two categories. The product parameters include all the features that characterize the product selection while the first category contains all the rest of parameters.
## A button to reload the default settings that allows to reset the original parameters of the module.
+
##A button to reload the default settings that allows to reset the original parameters of the module.
  
 
<br />
 
<br />
 
[[File:CashdeskPar setup page.png|alt=CashdeskPar setup page|none|thumb|1300x1300px|Cashdesk parameters]]
 
[[File:CashdeskPar setup page.png|alt=CashdeskPar setup page|none|thumb|1300x1300px|Cashdesk parameters]]
  
= Modification of parameters: =
+
=Modification of parameters:=
 
By clicking on the "Cashdesk Parameters" link, we discover the 26 current parameters of this category :
 
By clicking on the "Cashdesk Parameters" link, we discover the 26 current parameters of this category :
 
[[File:Capture d’écran de 2019-12-04 12-37-33.png|alt=Point of Sale Category parameters|none|thumb|1300x1300px|Point of Sale Category parameters]]
 
[[File:Capture d’écran de 2019-12-04 12-37-33.png|alt=Point of Sale Category parameters|none|thumb|1300x1300px|Point of Sale Category parameters]]
Line 63: Line 62:
 
The list of parameters is displayed on a table of 5 columns:
 
The list of parameters is displayed on a table of 5 columns:
  
# The number and name of the parameter that can be referenced from the description of another parameter.
+
#The number and name of the parameter that can be referenced from the description of another parameter.
# The summary description of the function of the parameter, in addition to the lower and upper bounds for the interval type parameters placed in red brackets.
+
#The summary description of the function of the parameter, in addition to the lower and upper bounds for the interval type parameters placed in red brackets.
# The value of the parameter: It displays the type of parameter according to its type (boolean, string or interval). For Boolean parameters, an activation or deactivation button and an entry field for the channels and interval are displayed. Entering an interval value outside the specified values ​​causes an error message to be displayed and the parameter input to be rejected.
+
#The value of the parameter: It displays the type of parameter according to its type (boolean, string or interval). For Boolean parameters, an activation or deactivation button and an entry field for the channels and interval are displayed. Entering an interval value outside the specified values ​​causes an error message to be displayed and the parameter input to be rejected.
# An icon with a question mark that uses the tiptip widget to display detailed information about the setting as soon as you move the pointer over the mouse.
+
#An icon with a question mark that uses the tiptip widget to display detailed information about the setting as soon as you move the pointer over the mouse.
# A button to show or hide the setting on the Cashdeskpar main page.
+
#A button to show or hide the setting on the Cashdeskpar main page.
  
= CashdeskPar POS Page: =
+
=CashdeskPar POS Page:=
 
Below is the improved image of the POS CashdeskPar page with parameters subsections closed.
 
Below is the improved image of the POS CashdeskPar page with parameters subsections closed.
  
 
We immediately see the difference with Dolibarr's original module:
 
We immediately see the difference with Dolibarr's original module:
  
# Enhanced theme with items in the basket that occupy only two lines. This makes it possible to display many more elements on a reduced page length.
+
#Enhanced theme with items in the basket that occupy only two lines. This makes it possible to display many more elements on a reduced page length.
# A parameter section with 30 parameters to enable/disable to control the operation of the point of sale.
+
#A parameter section with 30 parameters to enable/disable to control the operation of the point of sale.
# The "Resume Sale" button, which takes the whole line above the parameterization section to enable the modification of the parameter to be applied to the point of sale screen by updating the page and keeping the values entered.
+
#The "Resume Sale" button, which takes the whole line above the parameterization section to enable the modification of the parameter to be applied to the point of sale screen by updating the page and keeping the values entered.
# By positioning the mouse over the "Make focus to list when reference empty" parameter, a detailed description of the parameter is displayed.
+
#By positioning the mouse over the "Make focus to list when reference empty" parameter, a detailed description of the parameter is displayed.
# The parameter table is displayed with only four columns. The fifth column that controls the display of the parameter at the point of sale is reserved for administrators and only appears on the configuration page.
+
#The parameter table is displayed with only four columns. The fifth column that controls the display of the parameter at the point of sale is reserved for administrators and only appears on the configuration page.
 +
 
 +
[[File:Capture d’écran de 2019-12-04 13-28-01.png|alt=CashdeskPar POS page with one of the closed setup items|none|thumb|950x950px|CashdeskPar POS page with  closed parameter sub-sections]]
 +
and with the parameters of the point of sale open:
 +
[[File:Capture d’écran de 2019-12-04 13-33-46.png|alt=CashdeskPar POS page with an open parameters subsection|none|thumb|1075x1075px|CashdeskPar POS page with an open parameters subsection]]
 +
 
 +
= Cahdeskpar on phone: =
 +
The following image shows CashdeskPar on phone with optimization of the display of basket items and parameters:
 +
[[File:Capture d’écran de 2019-12-04 13-38-31.png|alt=Cashdeskpar on phone|none|thumb|840x840px|'''Cashdeskpar on phone''']]
 +
 
 +
= Some parameters: =
 +
There is no need to explain the operation of each of the 30 current CashdeskPar settings. This number is also expected to increase over time. Then you only have to connect to the demonstration site: dolipar.org/dolibarr , to fly over any element to have a complete description, and then to test it online. In the demo site, all settings are configured to appear in the POS page.
 +
 
 +
Here are some examples of some particular parameters:
 +
 
 +
# The parameter "autocomplete form for product selection" replaces the entry with filter and choice fields with a single autocomplete input field that will be parameterizable by the two product parameters "Number of autocomplete results", "Number of autocomplete minimum characters for search in autocomplete "and" Enable Autoselect on references only "
 +
# The "Dolibarr 3.1 theme" parameter replaces the current theme with an old theme from Dolibarr version 3.1. It is planned to include additional themes as users request.
 +
 
 +
= Other sources of information: =
 +
Dolipar.org module information page: http://dolipar.org/en/content/cashdeskpar
  
 +
Discussion topic on the Francophone Forum of Dolibarr: https://www.dolibarr.fr/forum/t/cashdeskpar-the-pos-parametrable-de-dolibarr/31142/2
  
 +
Videos on Youtube demonstration of the first version of CashdekPar in 2014 in French: [https://youtu.be/u5RszMJrTW8 Part 1] and [https://youtu.be/SOPjVJvo3RE Part 2]
 +
<br />
 
[[Category:Complementary modules]]
 
[[Category:Complementary modules]]
 
[[Category:CashdeskPar]]
 
[[Category:CashdeskPar]]

Revision as of 13:48, 4 December 2019

²

Return to developer
documentation index

File Doc dev.png

Informations

Module name Cashdeskpar
Editor / Editeur Dolipar.org - http://dolipar.org/content/cashdeskpar
Download or buy page / Page achat ou téléchargement https://www.dolistore.com/fr/modules/368-CashDeskPar.html
Status / Statut / Estado Stable
Prerequisites / Prérequis Dolibarr min version 9.0.0   
Last update date / Date mise à jour fiche / Fecha última actualización 2019-12-4
Note / Nota

Summary: [edit | edit source]

CashdeskPar is the first module to offer an improvement of Dolibarr's original point of sale. It was developed in 2014 on the version 3.1 of Dolibarr. Since then, it has gathered many new features to configure through its thirty parameters.

Installation

  • Download the module archive file (.zip) from the www.dolistore.com website or retrieve it in any other way.
  • Put the file in the root directory of dolibarr or create a custom folder at the root of Dolibarr to place it with all your additional modules (If you choose this solution, remember to uncomment the two lines of the conf file)
  • Unzip the file with the command unzip module_Cashdeskpar-X.Y.Z.zip
  • The correct location of the module must be of the type: htdocs/custom /cashdeskpar.
  • Go to the installation location of the module and give read and write privileges to the PHP server for the following files:
  1. cashdeskpar_consts.php
  2. cashdeskpar_default_consts.php

The module is operational and may be activated.

Configuration

To use this module, you must first activate it. To do this, after logging in with an administrator account, go to " Home - Configuration - Modules " page. The module appears in "Produc /Service Management (PM)", click "Activate". A pictogram appears at the end of the line of the module, click on it to access the setup page specific to this module:

CashdeskPar setup Page

The setup page consists of two parts:

  1. The upper part is identical to that of Dolibarr's point-of-sale module.
  2. The lower part contains the CashdeskPar- specific parameterizing section , which itself consists of two sub-sections:
    1. Parameters subsection: This section contains all the parameters that change the behavior of the module. It consists of two foldable titles that separate the parameters into two categories. The product parameters include all the features that characterize the product selection while the first category contains all the rest of parameters.
    2. A button to reload the default settings that allows to reset the original parameters of the module.


CashdeskPar setup page
Cashdesk parameters

Modification of parameters:

By clicking on the "Cashdesk Parameters" link, we discover the 26 current parameters of this category :

Point of Sale Category parameters
Point of Sale Category parameters

And clicking on the category product parameters, we discover a list of 5 parameters:

Product category parameters
Product category parameters

The list of parameters is displayed on a table of 5 columns:

  1. The number and name of the parameter that can be referenced from the description of another parameter.
  2. The summary description of the function of the parameter, in addition to the lower and upper bounds for the interval type parameters placed in red brackets.
  3. The value of the parameter: It displays the type of parameter according to its type (boolean, string or interval). For Boolean parameters, an activation or deactivation button and an entry field for the channels and interval are displayed. Entering an interval value outside the specified values ​​causes an error message to be displayed and the parameter input to be rejected.
  4. An icon with a question mark that uses the tiptip widget to display detailed information about the setting as soon as you move the pointer over the mouse.
  5. A button to show or hide the setting on the Cashdeskpar main page.

CashdeskPar POS Page:

Below is the improved image of the POS CashdeskPar page with parameters subsections closed.

We immediately see the difference with Dolibarr's original module:

  1. Enhanced theme with items in the basket that occupy only two lines. This makes it possible to display many more elements on a reduced page length.
  2. A parameter section with 30 parameters to enable/disable to control the operation of the point of sale.
  3. The "Resume Sale" button, which takes the whole line above the parameterization section to enable the modification of the parameter to be applied to the point of sale screen by updating the page and keeping the values entered.
  4. By positioning the mouse over the "Make focus to list when reference empty" parameter, a detailed description of the parameter is displayed.
  5. The parameter table is displayed with only four columns. The fifth column that controls the display of the parameter at the point of sale is reserved for administrators and only appears on the configuration page.
CashdeskPar POS page with one of the closed setup items
CashdeskPar POS page with closed parameter sub-sections

and with the parameters of the point of sale open:

CashdeskPar POS page with an open parameters subsection
CashdeskPar POS page with an open parameters subsection

Cahdeskpar on phone:

The following image shows CashdeskPar on phone with optimization of the display of basket items and parameters:

Cashdeskpar on phone
Cashdeskpar on phone

Some parameters:

There is no need to explain the operation of each of the 30 current CashdeskPar settings. This number is also expected to increase over time. Then you only have to connect to the demonstration site: dolipar.org/dolibarr , to fly over any element to have a complete description, and then to test it online. In the demo site, all settings are configured to appear in the POS page.

Here are some examples of some particular parameters:

  1. The parameter "autocomplete form for product selection" replaces the entry with filter and choice fields with a single autocomplete input field that will be parameterizable by the two product parameters "Number of autocomplete results", "Number of autocomplete minimum characters for search in autocomplete "and" Enable Autoselect on references only "
  2. The "Dolibarr 3.1 theme" parameter replaces the current theme with an old theme from Dolibarr version 3.1. It is planned to include additional themes as users request.

Other sources of information:

Dolipar.org module information page: http://dolipar.org/en/content/cashdeskpar

Discussion topic on the Francophone Forum of Dolibarr: https://www.dolibarr.fr/forum/t/cashdeskpar-the-pos-parametrable-de-dolibarr/31142/2

Videos on Youtube demonstration of the first version of CashdekPar in 2014 in French: Part 1 and Part 2