Module PIXBrasil: Difference between revisions

Jump to navigation Jump to search

Module PIXBrasil (view source)

Revision as of 12:37, 7 April 2022

1,737 bytes added ,  4 years ago
→‎Logo
VisualWikitext
(testando)
Tag: 2017 source edit
 
Line 15: Line 15:
}}
}}
=<small>Logo</small>=
=<small>Logo</small>=
[[Image:Logotipo500.jpg|200px|Logo]]
[[File:Pixbrasil.png|alt=|200x200px|Logo]]
=<small>Features</small>=
=<small>'''Features'''</small>=


'''PIXBrasil'''  PIX is a model of banking interaction through QRcode that allows you to carry out banking transactions without any typing or writing.
'''PIXBrasil'''  PIX is a model of banking interaction through QRcode that allows you to carry out banking transactions without any typing or writing.


1- Hide fields;
ABOUT THE DOLIBARR PIX BRASIL MODULE


2- Make fields as mandatory (Javascript);
=== '''When installing''' ===
When installing the module, a new pdf print template is created for sales invoices and a table with editable fields with null values. First, it is necessary to register the Company Name, Company Municipality and PIX Key fields. With the 3 fields filled in, the system generates a new page in the sales invoices with the QRcode PIX and the field copies and pastes the PIX text. The value field is the invoice total and the other fields are mandatory according to the BACEN model.


3- Disable fields;
=== How to register ===
To register the Company Name field, simply click on the pencil and type the Name that you want to be printed on the QRcode and on the PIX COPIEeCOLE. This field is limited to 25 characters and does not allow the use of symbols and accents.


4- Create Custom Header and Footer;
To register the Company's Municipality field, simply click on the pencil and type the Municipality name that you want to be printed in the QRcode and in the PIX COPIEeCOLE. This field is limited to 15 characters and does not allow the use of symbols and accents.


5- Define default values for fields (texts, lists, html, selection and categories);
To register the PIX Key field, simply click on the pencil and type the PIX Key that you want to be printed in the QRcode and in the PIX COPIEeCOLE. This field can be an email, CNPJ, CPF or a random Key.


6- Create tooltip with instructions on the fields;
=== To use ===
When printing an invoice, choose the pixbrasil template and generate the document. The invoice with one page with the PIX will be printed in the pdf document.


7- Create auxiliary lists of preformatted texts and phrases to easily insert into the fields (text, html);
If you do not want the PIX to appear on the invoice, just leave one or more fields without value.


8- Change the presented names of the fields without changing the translations;
The Invoice code (Only numbers and letters, symbols are suppressed) is registered in the PIX, so it is possible to quickly identify the invoice in the system
=<small>Install</small>=
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.
=== Comments ===
The PIX Key needs to be registered at any bank in Brazil to be valid for transactions.


3- Click on the '''Customize Forms''' link and you will be taken to the system home page.
When installing the module, the PIX payment method will be entered in the payment options.


=<small>Permissions:</small>=
=== Safety ===
1- Initial system permissions are set with access only to the System Administrator;
The PIXBRASIL module creates a hash containing the information of the Receiver and the unique security identifier of each Dolibarr. In this way, modifying the PIX Key directly via the database will prevent the PIX from being printed, guaranteeing the integrity of the QRCode generated only from the system. The Hash will be created whenever the PIXBRASIL module information is changed by the system administrator or by a user with writing permission to the module.


2- For new users, the administrator can configure read, edit, and delete permissions on the Dolibarr user or group permissions tab.


=<small>Pages</small>=
==== O módulo Dolibarr PIXBRASIL ====
O Módulo Pix Brasil cria um modelo de impressão para o Dolibarr nos arquivos pdf das faturas de vendas que permite imprimir o PIX para pagamento em todos os bancos do Brasil. Dessa forma, os clientes podem receber as faturas por email ou whatsapp e pagá-las rapidamente em qualquer dispositivo que aceite o PIX como pagamento.


The '''Customize Forms''' Module is very simple to configure, has only 3 control pages:
==== SOBRE O PIX ====
O PIX é um modelo de interação bancária por meio de código QRcode que permite realizar transações bancárias sem nenhuma digitação ou escrita. O modelo PIX permite também copiar e colar o texto gerador do QRcode, facilitando o compartilhamento e aumentando a segurança das transações.


==<small>Page 1 - Home Page - List Forms</small>==
=== SOBRE O MÓDULO DOLIBARR PIX BRASIL ===


*The Home Page lists all 24 Dolibarr forms that can be configured by Customizeforms.
==== Ao Instalar ====
*The Qty column tells you how many fields can be set on each form.
Na instalação do módulo é criado um novo modelo de impressão em pdf nas faturas de vendas e a tabela com os campos editáveis com valores nulos. Primeiramente é necessário cadastrar os campos Nome da Empresa, Município da Empresa e Chave PIX. Com os 3 campos preenchidos, o sistema gera uma nova página nas faturas de vendas com o código QRcode PIX e o campo copia e cola do texto do PIX. O campo valor é o total da fatura e os demais campos são obrigatórios conforme o modelo do BACEN.
*To '''Customize''' a Form, just click the pencil on the right form.


[[Image:Pagina1.png|800px|HomePage]]
==== Como cadastrar ====
Para cadastrar o campo Nome da Empresa, basta clicar no lápis e digitar o Nome que deseja ser impresso no QRcode e no PIX COPIEeCOLE. Este campo possui limitações de 25 caracteres e não permite o uso de símbolos e acentuação.


==<small>Page 2 - List All Form Fields to Customize</small>==
Para cadastrar o campo Município da Empresa, basta clicar no lápis e digitar o Nome do Município que deseja ser impresso no QRcode e no PIX COPIEeCOLE. Este campo possui limitações de 15 caracteres e não permite o uso de símbolos e acentuação.
*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.
Para cadastrar o campo Chave PIX, basta clicar no lápis e digitar a Chave PIX que deseja ser impresso no QRcode e no PIX COPIEeCOLE. Este campo pode ser um email, CNPJ, CPF ou uma Chave aleatória.


2 - The '''Header''' and '''footer''' fields are options that can be added to the form.
==== Para utilizar ====
Ao imprimir uma fatura, escolha o modelo pixbrasil e gere o documento. Será impresso no documento pdf a fatura com uma página com o PIX.


[[Image:Pagina2.png|800px|Form]]
Se desejar não aparecer o PIX na fatura, basta deixar um ou mais campos sem valor.


'''Presentation the table: '''
O código da Fatura (Somente números e letras, os símbolos são suprimidos) é cadastrado no PIX, dessa forma é possível identificar a fatura rapidamente no sistema
The fields are listed in the columns as follows:


*'''Name''': Field Name
==== Observações ====
*'''Situation''': Current field status - Can be Visible, Invisible, Disabled, or Required.
A Chave PIX precisa ser cadastrada em qualquer banco no Brasil para ter validade nas transações.
*'''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.


==<small>Page 3 - Customizing a form field</small>==
Ao instalar o módulo, será inserido o modo de pagamento PIX nas opções de pagamento.
In this example, we click in the '''New Commercial Proposal - Customer''' form (Page 1) and after we click on the '''Customer''' field (Page 2).


===To apply module functionality to the form example:===
==== Segurança ====
O módulo PIXBRASIL cria um hash contendo as informações do Recebedor e do identificador único de segurança de cada Dolibarr. Dessa forma, a modificação da Chave PIX diretamente via banco de dados impedirá a impressão do PIX, garantindo a integridade do QRCode gerado somente a partir do sistema. O Hash será criado sempre que as informações do módulo PIXBRASIL forem alteradas pelo administrador do sistema ou por usuário com permissão de escrita ao módulo.


*'''To Hide fields:'''
=<small>Install</small>=
**Click in the combo box '''Define Visibility and Mandatory''' and select '''Invisible''' option (The entire line will be invisible);
1- To Install the module, simply unzip the files and place in the '''custom''' folder of the Dolibarr directory and then '''Activate''' the module.


*'''To Make fields as mandatory''' (Javascript):
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.
**Click in the combo box '''Define Visibility and Mandatory''' and select '''Required''' option;


*'''To Disable field:'''
3- Click on the '''PixBrasil''' link and you will be taken to the system home page.
**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):
=<small>Permissions:</small>=
**Click in the combo box '''Set Default Value'''  and select the desired option (Dolibarr options to combo box and checkbox, other field type only write the text to default value);
1- Initial system permissions are set with access only to the System Administrator;


*'''To Change the presented name of the field''' without changing the translations:
2- For new users, the administrator can configure read, edit, and delete permissions on the Dolibarr user or group permissions tab.
**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):
=<small>Pages</small>=
**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;'''  
*'''To put the date (future and past) in the date fields''' :
**It is possible to define '''future and past dates''' in all date fields, just put the text '''now(0)''' for the current day, '''now(+5)''' for 5 days later, or '''now(-5)''' for 5 days previous in the default value, for example;


The '''PIXBrasil''' Module is very simple to configure, has only 1 control page:


[[Image:Pagina3.png|800px|CustomizeForms]]
==<small>Page 1 - Home Page - List Fields</small>==


===To create Headers and Footers on a form:===
[[File:Tela1.png|alt=Tela 1 Module PIXBrasil|800x800px|HomePage]]


1- Choose the form on the home page of the module (Page 1);
==<small>Page 1 - Help Link</small>==


2- In the chosen form, click in the Header or Footer field (Page 2);
[[File:Tela2.png|alt=Tela 1 Module PIXBrasil|800x800px|HomePage]]


3- In Page 3:
==<small>Facture PDF - Example PixBrasil</small>==


*Click in the combo box '''Define Visibility and Mandatory'''  and select '''Visible''' option;
[[File:Tela3.png|alt=Facture Print|783x783px|HomePage]]
*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;


=<small>Prerequisites</small>=  
=<small>'''Prerequisites'''</small>=  


Partial Features - Dolibarr ≥ 5.0.3
Partial Features - Dolibarr ≥ 5.0.3
Line 132: Line 116:
=<small>Demo</small>=  
=<small>Demo</small>=  


View DEMO:https://trucolivre.com.br/dolibarr/ user:demo passw:demo
View DEMO:https://empresalivre.com/demo1/ user:demo passw:demo
=<small>Buy</small>=
=<small>Buy</small>=
On https://www.dolistore.com/en/modules/1133-Customize-Forms.html
On https://www.dolistore.com/en/modules/1133-Customize-Forms.html
Line 146: Line 130:
====Categorize All====
====Categorize All====
https://wiki.dolibarr.org/index.php/Module_CategorizeAll
https://wiki.dolibarr.org/index.php/Module_CategorizeAll
====Customize Forms====
https://wiki.dolibarr.org/index.php/Module_CustomizeForms
Paulorcdo
202

edits

Retrieved from "https://wiki.dolibarr.org/index.php/Special:MobileDiff/53398"

Navigation menu