Developing Plug-Ins - ITaxProviderFactory - Revision history

Diego.ruiz: Categorize and tag -- No mention of annotations

2022-09-06T10:28:30Z

Categorize and tag -- No mention of annotations

Thomas Thießen: Add category

2015-07-27T18:12:03Z

Add category

Alan.lesc1: /* The workflow */

2014-03-08T12:22:29Z

The workflow

Alan.lesc1: /* Troubleshooting */

2014-03-08T11:54:04Z

Troubleshooting

Alan.lesc1: /* The workflow */

2014-03-08T10:57:16Z

The workflow

Alan.lesc1: Created page with "Category:Plug-In Development TOC This tutorial was brought to you by Alan Lescano from LBR Localization Brazil...."

2014-03-08T10:54:41Z

Created page with "Category:Plug-In Development __TOC__ This tutorial was brought to you by Alan Lescano from LBR Localization Brazil...."

New page

[[Category:Plug-In Development]]
__TOC__
This tutorial was brought to you by [[User:Alan.lesc1|Alan Lescano]] from [[Plugin:_LBR_Localization_Brazil|LBR Localization Brazil]]. If you have questions, criticism or improvement suggestions, feel free to visit me ([[User:Alan.lesc1|Alan.lesc1]]) or write me [mailto:alan.lesc1@gmail.com an email]
=Goal of this tutorial=
The goal of this tutorial is to show, how you use the ITaxProviderFactory service in you plug-in project. The reason why you want to use the tax provider factory service is, that you can provide your own method for calculating taxes on orders, invoices and RMAs.

=Prerequisites=
Before you start this tutorial, you should take a look at the follwing tutorials:
* [[Developing_plug-ins_without_affecting_the_trunk|Developing Plug-Ins without affecting the Trunk]]
* [[Developing_Plug-Ins_-_Get_your_Plug-In_running|Developing Plug-Ins - Get your Plug-In started]]

=The workflow=
After creating the plug-in and setting its dependencies, click on File>New>Others and select "Component Definition" from the Plug-in Development section.

[[File:Plugin_ITaxProviderFactory_Menu.png|320px]]

Click on next. Select your plug-in project (OSGI folder) and choose a file name and a general name. In our example, we used "TaxProviderFactory.xml" and "org.idempierelbr.tax.TaxProviderFactory" for filename/name but every other name is okay too. You don't need to set the class name yet because we haven't implemented one. Click on finish.

[[File:Plugin_ITaxProviderFactory_CompDefinitionTree.png|320px]]

[[File:Plugin_ITaxProviderFactory_CompDefinition.png|320px]]

The next things we will need is:
*A TaxProvider (a class which implements ITaxProvider)
*A TaxProviderFactory (a class which implements ITaxProviderFactory)
You need only one TaxProviderFactory for all your TaxProvider (just in case you have more than one). Create the class DefaultTaxProvider which implements org.adempiere.model.ITaxProvider and implement the inherited abstract methods.

[[File:Plugin_ITaxProviderFactory_DefaultTaxProvider.png|320px]]

The second class only implements ITaxProviderFactory and is called TaxProviderFactory. In newTaxProviderInstance() we check the class name configurable in Tax Provider Configuration window (see below).

[[File:Plugin_ITaxProviderFactory_TaxProviderFactory.png|320px]]

Open the TaxProviderFactory.xml and click on the Browse button to select the TaxProviderFactory class. Also add a integer property called "service.ranking" with a positive value (>0).

[[File:Plugin_ITaxProviderFactory_TaxProviderFactoryXML.png|320px]]

On the Services tab, add the org.adempiere.base.ITaxProviderFactory to the "Provided Services" section.

[[File:Plugin_ITaxProviderFactory_TaxProviderFactoryXML_Services.png|320px]]

Now, you should configure your client to use the new tax provider.

[[File:Plugin_ITaxProviderFactory_TPConfigWindow.png|320px]]

[[File:Plugin_ITaxProviderFactory_TPWindow.png|320px]]

Basically thats all you need to do. To see that we realy did someting, we've added a console log in each method of DefaultTaxProvider class.
Make sure that your plug-in is active in the run configurations. Start the client and make sure your plug-in is active. Now log in as GardenAdmin/GardenWorld and create a new Sales Order fill in all mandatory fields and click on save. Take a look at your console log, you should see the log from your custom tax provider.

Don't forget to implement each method of DefaultTaxProvider to calculate taxes for orders, invoices and RMAs!

=Troubleshooting=
*Make sure that in your TaxProviderFactory.xml you have a unique name (my.domainname.pluginname.model.TaxProviderFactory is a good idea) and that you selected the right class
*Make sure your plug-in is activated before you log in
*Make sure your MANIFEST.MF contains a row with "Service-Component: " and the path to your TaxProviderFactory.xml (e. g. "Service-Component: TaxProviderFactory.xml")

@@ Line 2: / Line 2: @@
 [[Category:Developer documentation‏‎]]
 [[Category:Plug-In Development]]
 __TOC__
-This tutorial was brought to you by [[User:Alan.lesc1|Alan Lescano]] from [[Plugin:_LBR_Localization_Brazil|LBR Localization Brazil]]. If you have questions, criticism or improvement suggestions, feel free to visit me ([[User:Alan.lesc1|Alan.lesc1]]) or write me [mailto:alan.lesc1@gmail.com an email]
+This How-To was brought to you by [[User:Alan.lesc1|Alan Lescano]] from [[Plugin:_LBR_Localization_Brazil|LBR Localization Brazil]]. If you have questions, criticism or improvement suggestions, feel free to visit me ([[User:Alan.lesc1|Alan.lesc1]]) or write me [mailto:alan.lesc1@gmail.com an email]
-=Goal of this tutorial=
+=Goal of this How-To=
-The goal of this tutorial is to show, how you use the ITaxProviderFactory service in you plug-in project. The reason why you want to use the tax provider factory service is, that you can provide your own method for calculating taxes on orders, invoices and RMAs.
+The goal of this How-To is to show, how you use the ITaxProviderFactory service in you plug-in project. The reason why you want to use the tax provider factory service is, that you can provide your own method for calculating taxes on orders, invoices and RMAs.
 =Prerequisites=
-Before you start this tutorial, you should take a look at the follwing tutorials:
+Before you start this How-To, you should take a look at the following How-Tos:
 * [[Developing_plug-ins_without_affecting_the_trunk|Developing Plug-Ins without affecting the Trunk]]
 * [[Developing_Plug-Ins_-_Get_your_Plug-In_running|Developing Plug-Ins - Get your Plug-In started]]
@@ Line 52: / Line 54: @@
 [[File:Plugin_ITaxProviderFactory_TaxRateWindow.png|320px]]
-Basically thats all you need to do. To see that we realy did someting, we've added a console log in each method of DefaultTaxProvider class.
+Basically that's all you need to do. To see that we really did something, we've added a console log in each method of DefaultTaxProvider class.
-Make sure that your plug-in is active in the run configurations. Start the client and make sure your plug-in is active. Now log in as GardenAdmin/GardenWorld and create a new Sales Order and save. Add some product (set the tax field to Standard), back to the header and prepare the order. Take a look at your console log, you should see the log from your custom tax provider.
+Make sure that your plug-in is active in the run configurations. Start the client and make sure your plug-in is active. Now log in as GardenAdmin/GardenWorld and create a new Sales Order and save. Add some products (set the tax field to Standard), back to the header and prepare the order. Take a look at your console log, you should see the log from your custom tax provider.
 Don't forget to implement each method of DefaultTaxProvider to calculate taxes for orders, invoices and RMAs!

← Older revision		Revision as of 18:12, 27 July 2015
Line 1:		Line 1:
		+	[[Category:Development\|P]]
		+	[[Category:Developer documentation‏‎]]
	[[Category:Plug-In Development]]		[[Category:Plug-In Development]]
	__TOC__		__TOC__

@@ Line 40: / Line 40: @@
 [[File:Plugin_ITaxProviderFactory_TaxProviderFactoryXML_Services.png|320px]]
-Now, you should configure your client to use the new tax provider.
+Now, you should configure your Client to use the new tax provider.
 [[File:Plugin_ITaxProviderFactory_TPConfigWindow.png|320px]]
 [[File:Plugin_ITaxProviderFactory_TPWindow.png|320px]]
 Basically thats all you need to do. To see that we realy did someting, we've added a console log in each method of DefaultTaxProvider class.
-Make sure that your plug-in is active in the run configurations. Start the client and make sure your plug-in is active. Now log in as GardenAdmin/GardenWorld and create a new Sales Order fill in all mandatory fields and click on save. Add some lines, back to header and prepare the order. Take a look at your console log, you should see the log from your custom tax provider.
+Make sure that your plug-in is active in the run configurations. Start the client and make sure your plug-in is active. Now log in as GardenAdmin/GardenWorld and create a new Sales Order and save. Add some product (set the tax field to Standard), back to the header and prepare the order. Take a look at your console log, you should see the log from your custom tax provider.
 Don't forget to implement each method of DefaultTaxProvider to calculate taxes for orders, invoices and RMAs!

@@ Line 52: / Line 52: @@
 =Troubleshooting=
-*Make sure that in your TaxProviderFactory.xml you have a unique name (my.domainname.pluginname.model.TaxProviderFactory is a good idea) and that you selected the right class
+*Make sure that in your TaxProviderFactory.xml you have a unique name (my.domainname.pluginname.provider.TaxProviderFactory is a good idea) and that you selected the right class
 *Make sure your plug-in is activated before you log in
 *Make sure your MANIFEST.MF contains a row with "Service-Component: " and the path to your TaxProviderFactory.xml (e. g. "Service-Component: TaxProviderFactory.xml")

Developing Plug-Ins - ITaxProviderFactory - Revision history

Diego.ruiz: Categorize and tag -- No mention of annotations

Thomas Thießen: Add category

Alan.lesc1: /* The workflow */

Alan.lesc1: /* Troubleshooting */

Alan.lesc1: /* The workflow */

Alan.lesc1: Created page with "Category:Plug-In Development __TOC__ This tutorial was brought to you by Alan Lescano from LBR Localization Brazil...."

Alan.lesc1: Created page with "Category:Plug-In Development TOC This tutorial was brought to you by Alan Lescano from LBR Localization Brazil...."