Difference between revisions of "Module CustomizeForms"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
Tag: 2017 source edit
Line 4: Line 4:
 
{{TemplateDocDev}}
 
{{TemplateDocDev}}
 
{{TemplateDocUtil}}
 
{{TemplateDocUtil}}
= Informations =
+
=Informations=
 
{{TemplateModuleInfo
 
{{TemplateModuleInfo
 
|modulename=CustomizeForms
 
|modulename=CustomizeForms
Line 14: Line 14:
 
|note=Module CustomizeForms
 
|note=Module CustomizeForms
 
}}
 
}}
= Logo =
+
=Logo=
 
[[Image:Logotipo500.jpg|200px|Logo]]
 
[[Image:Logotipo500.jpg|200px|Logo]]
= Features =
+
=Features=
  
 
'''Customize Forms'''  allows you to create  new features in 24 dolibarr forms ( + 430 standard fields and + all extra fields)
 
'''Customize Forms'''  allows you to create  new features in 24 dolibarr forms ( + 430 standard fields and + all extra fields)
Line 37: Line 37:
  
  
= Install =
+
=Install=
 
1- To Install the module, simply unzip the files and place in the '''custom''' folder of the Dolibarr directory and then '''Activate''' the module.
 
1- To Install the module, simply unzip the files and place in the '''custom''' folder of the Dolibarr directory and then '''Activate''' the module.
  
Line 43: Line 43:
  
 
3- Click on the '''Customize Forms''' link and you will be taken to the system home page.
 
3- Click on the '''Customize Forms''' link and you will be taken to the system home page.
= Screens =
+
 
 +
=Pages=
  
 
The '''Customize Forms''' Module is very simple to configure, has only 3 control pages:
 
The '''Customize Forms''' Module is very simple to configure, has only 3 control pages:
  
== Page 1 - Home Page ==  
+
==Page 1 - Home Page==  
 
'''Home Page - List Forms:'''
 
'''Home Page - List Forms:'''
  
* The Home Page lists all 24 Dolibarr forms that can be configured by Customizeforms.  
+
*The Home Page lists all 24 Dolibarr forms that can be configured by Customizeforms.
* The Qty column tells you how many fields can be set on each form.
+
*The Qty column tells you how many fields can be set on each form.
* To '''Customize''' a Form, just click the pencil on the right form.
+
*To '''Customize''' a Form, just click the pencil on the right form.
  
 
[[Image:Pagina1.png|800px|HomePage]]
 
[[Image:Pagina1.png|800px|HomePage]]
  
== Page 2 - List All Form Fields to Customize ==  
+
==Page 2 - List All Form Fields to Customize==  
 
'''Page Edit Form - List All Form Fields:'''
 
'''Page Edit Form - List All Form Fields:'''
  
* In this example, we click on the '''Home Page''' in the '''New Commercial Proposal - Customer''' form.
+
*In this example, we click on the '''Home Page''' in the '''New Commercial Proposal - Customer''' form.
* This page only displays fields with default values that have already been set. All fields of the form are displayed on this page.
+
*This page only displays fields with default values that have already been set. All fields of the form are displayed on this page.
  
 
1 - '''Extrafields''' that were created for this module will be inserted automatically when you open the page.
 
1 - '''Extrafields''' that were created for this module will be inserted automatically when you open the page.
Line 70: Line 71:
 
'''Presentation the table: '''
 
'''Presentation the table: '''
 
The fields are listed in the columns as follows:
 
The fields are listed in the columns as follows:
 +
 
*'''Name''': Field Name
 
*'''Name''': Field Name
 
*'''Situation''': Current field status - Can be Visible, Invisible, Disabled, or Required.
 
*'''Situation''': Current field status - Can be Visible, Invisible, Disabled, or Required.
Line 75: Line 77:
 
*'''Tag''': New Name Defined for Field
 
*'''Tag''': New Name Defined for Field
 
*'''Auxiliary List''': List of Text separated by line breaks that can be added in any text field or textarea.
 
*'''Auxiliary List''': List of Text separated by line breaks that can be added in any text field or textarea.
*'''Help Text''': Help text that appears when you approach the mouse.  
+
*'''Help Text''': Help text that appears when you approach the mouse.
  
== Page 2 - Customizing a form field ==  
+
==Page 2 - Customizing a form field==  
 
'''Page Edit Field:'''
 
'''Page Edit Field:'''
  
Line 84: Line 86:
 
===To apply module functionality to the form example:===
 
===To apply module functionality to the form example:===
  
* '''To Hide fields:
+
*'''To Hide fields:'''
** Click in the combo box '''Define Visibility and Mandatory'''  and select '''Invisible''' option
+
**Click in the combo box '''Define Visibility and Mandatory'''  and select '''Invisible''' option
  
* '''To Make fields as mandatory''' (Javascript);
+
*'''To Make fields as mandatory''' (Javascript);
** Click in the combo box '''Define Visibility and Mandatory'''  and select '''Required''' option
+
**Click in the combo box '''Define Visibility and Mandatory'''  and select '''Required''' option
  
* '''To Disable field''';
+
*'''To Disable field''';
** Click in the combo box '''Define Visibility and Mandatory'''  and select '''Disable''' option
+
**Click in the combo box '''Define Visibility and Mandatory'''  and select '''Disable''' option
  
* '''To Define default values''' for field (texts, lists, html, selection and categories);
+
*'''To Define default values''' for field (texts, lists, html, selection and categories);
** Click in the combo box '''Set Default Value'''  and select the desired option (Dolibarr options to combo box and checkbox, other field type only digit text to default value)
+
**Click in the combo box '''Set Default Value'''  and select the desired option (Dolibarr options to combo box and checkbox, other field type only digit text to default value)
  
* '''To Change the presented name of the field''' without changing the translations;
+
*'''To Change the presented name of the field''' without changing the translations;
** Digit new name text to '''Modify Field Name'''  
+
**Digit new name text to '''Modify Field Name'''  
  
* '''To Create auxiliary lists''' of preformatted texts and phrases to easily insert into the fields (text, html);
+
*'''To Create auxiliary lists''' of preformatted texts and phrases to easily insert into the fields (text, html);
** Digit  List of Text separated by line breaks that can be added in any text field or textarea in '''Create Auxiliary List to insert into text or HTML fields'''  
+
**Digit  List of Text separated by line breaks that can be added in any text field or textarea in '''Create Auxiliary List to insert into text or HTML fields'''  
  
* '''To Create tooltip''' with instructions on the fields;
+
*'''To Create tooltip''' with instructions on the fields;
** Digit html text to '''Create Tooltip with Help Info'''  
+
**Digit html text to '''Create Tooltip with Help Info'''  
 
   
 
   
  
Line 115: Line 117:
 
2- In the chosen form, click in the Header or Footer field;
 
2- In the chosen form, click in the Header or Footer field;
  
* Click in the combo box '''Define Visibility and Mandatory'''  and select '''Visible''' option;
+
*Click in the combo box '''Define Visibility and Mandatory'''  and select '''Visible''' option;
* Digit new name text to '''Modify Field Name''', this field is a name of Header/Footer in the left table form;
+
*Digit new name text to '''Modify Field Name''', this field is a name of Header/Footer in the left table form;
* Digit html text  in the field '''Set Default Value''' , this field is a content of Header/Footer in the right table form;
+
*Digit html text  in the field '''Set Default Value''' , this field is a content of Header/Footer in the right table form;
  
  
= Prerequisites =  
+
=Prerequisites=  
  
 
Partial Features - Dolibarr ≥ 5.0.3
 
Partial Features - Dolibarr ≥ 5.0.3
Line 127: Line 129:
  
  
= Demo =  
+
=Demo=  
  
 
View DEMO:https://www.trucolivre.com.br/dolibarr/ user:demo passw:demo
 
View DEMO:https://www.trucolivre.com.br/dolibarr/ user:demo passw:demo
  
= Video =  
+
=Video=  
  
 
View Video: https://www.youtube.com/watch?v=wTR9DMnpIck
 
View Video: https://www.youtube.com/watch?v=wTR9DMnpIck

Revision as of 12:27, 28 July 2019

Informations

Module name CustomizeForms
Editor / Editeur paulorcdo - https://www.trucolivre.com.br/dolibarr/
Download or buy page / Page achat ou téléchargement External module - On [1]
Status / Statut / Estado Stable
Prerequisites / Prérequis

Dolibarr min version: See on Dolistore    Dolibarr max version: See on Dolistore

Last update date / Date mise à jour fiche / Fecha última actualización 2019-07-28
Note / Nota Module CustomizeForms

Logo

Features

Customize Forms allows you to create new features in 24 dolibarr forms ( + 430 standard fields and + all extra fields)

1- Hide fields;

2- Make fields as mandatory (Javascript);

3- Disable fields;

4- Create Custom Header and Footer;

5- Define default values for fields (texts, lists, html, selection and categories);

6- Create tooltip with instructions on the fields;

7- Create auxiliary lists of preformatted texts and phrases to easily insert into the fields (text, html);

8- Change the presented names of the fields without changing the translations;


Install

1- To Install the module, simply unzip the files and place in the custom folder of the Dolibarr directory and then Activate the module.

2- The module is installed in the Tools menu of Dolibarr, click on the menu and on the left will appear the link Customize Forms.

3- Click on the Customize Forms link and you will be taken to the system home page.

Pages

The Customize Forms Module is very simple to configure, has only 3 control pages:

Page 1 - Home Page

Home Page - List Forms:

  • The Home Page lists all 24 Dolibarr forms that can be configured by Customizeforms.
  • The Qty column tells you how many fields can be set on each form.
  • To Customize a Form, just click the pencil on the right form.

HomePage

Page 2 - List All Form Fields to Customize

Page Edit Form - List All Form Fields:

  • In this example, we click on the Home Page in the New Commercial Proposal - Customer form.
  • This page only displays fields with default values that have already been set. All fields of the form are displayed on this page.

1 - Extrafields that were created for this module will be inserted automatically when you open the page.

2 - The Header and footer fields are options that can be added to the form.

Form

Presentation the table: The fields are listed in the columns as follows:

  • Name: Field Name
  • Situation: Current field status - Can be Visible, Invisible, Disabled, or Required.
  • Default Value: Value set to appear as default for the field (text fields, checkbox, selects, textarea).
  • Tag: New Name Defined for Field
  • Auxiliary List: List of Text separated by line breaks that can be added in any text field or textarea.
  • Help Text: Help text that appears when you approach the mouse.

Page 2 - Customizing a form field

Page Edit Field:

In this example, we click in the New Commercial Proposal - Customer form on the Customer field.

To apply module functionality to the form example:

  • To Hide fields:
    • Click in the combo box Define Visibility and Mandatory and select Invisible option
  • To Make fields as mandatory (Javascript);
    • Click in the combo box Define Visibility and Mandatory and select Required option
  • To Disable field;
    • Click in the combo box Define Visibility and Mandatory and select Disable option
  • To Define default values for field (texts, lists, html, selection and categories);
    • Click in the combo box Set Default Value and select the desired option (Dolibarr options to combo box and checkbox, other field type only digit text to default value)
  • To Change the presented name of the field without changing the translations;
    • Digit new name text to Modify Field Name  
  • To Create auxiliary lists of preformatted texts and phrases to easily insert into the fields (text, html);
    • Digit List of Text separated by line breaks that can be added in any text field or textarea in Create Auxiliary List to insert into text or HTML fields  
  • To Create tooltip with instructions on the fields;
    • Digit html text to Create Tooltip with Help Info  


CustomizeForms


To create Headers and Footers on a form:

1- Choose the form on the home page of the module;

2- In the chosen form, click in the Header or Footer field;

  • Click in the combo box Define Visibility and Mandatory and select Visible option;
  • Digit new name text to Modify Field Name, this field is a name of Header/Footer in the left table form;
  • Digit html text in the field Set Default Value , this field is a content of Header/Footer in the right table form;


Prerequisites

Partial Features - Dolibarr ≥ 5.0.3

All Features - Dolibarr ≥ 9.0.3


Demo

View DEMO:https://www.trucolivre.com.br/dolibarr/ user:demo passw:demo

Video

View Video: https://www.youtube.com/watch?v=wTR9DMnpIck