Custom component overriding OOTB application example

[Alexandre Beaulieu]

Hello, we are currently evaluating Ofbiz to use it as our development framework as well a use existing features as much as possible.

Can anybody provide a custom component example (or guidelines) where a feature in an OOTB application such as party/partymgr is customised without having to copy most of the application in the component?

For example, if we want to add some custom contact mechanism type to party, it seems overkill to have to copy the whole partymgr webapp/widget in the custom component just to customise that.
I'm missing a bit of the specifics to achieve that kind of customisation from the guidelines I found so far.

So if anybody can point me to a good example or better guidelines, that would be great.

Thanks.


 

[Jacques Le Roux]

Hi Alexandre,

One point from which you could start is the ecomseo webapp in the ecommerce component (plugin).
There you will see that only the controller and web.xml are needed to reuse the ecommerce code while adjusting it for SEO needs.

Also you can extend forms (look for "extends" in *form*.xml files)  and entities (look for "extend-entity" in *mode*.xml files)

HTH

Jacques

Le 28/07/2019 à 20:44, Alexandre Beaulieu a écrit :

> Hello, we are currently evaluating Ofbiz to use it as our development framework as well a use existing features as much as possible.
>
> Can anybody provide a custom component example (or guidelines) where a feature in an OOTB application such as party/partymgr is customised without having to copy most of the application in the component?
>
> For example, if we want to add some custom contact mechanism type to party, it seems overkill to have to copy the whole partymgr webapp/widget in the custom component just to customise that.
> I'm missing a bit of the specifics to achieve that kind of customisation from the guidelines I found so far.
>
> So if anybody can point me to a good example or better guidelines, that would be great.
>
> Thanks.
>
>
>  
>

[adityasharma]

Hi Alexandre,

Adding to it. Here are some references

Extending form:
http://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins/branches/release17.12/birt/widget/accounting/AccountingForms.xml

Extending entity:
http://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins/branches/release17.12/projectmgr/entitydef/entitymodel.xml

For fields like Contact Mechanism, you can prepare data in your own
component and load it using ext reader

Doc on data readers:
https://www.hotwaxsystems.com/ofbiz/ofbiz-data-setupdata-reader-best-practices-tutorial/

List of existing  data readers can be found here:
http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/framework/entity/config/entityengine.xml:92
<http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/framework/entity/config/entityengine.xml>
You can use ext reader for your custom data (recommended) or even you can
have your own custom reader.

Associate file with the reader:
http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/applications/datamodel/ofbiz-component.xml

Preparing data:
http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/applications/datamodel/data/seed/PartySeedData.xml

Command for loading data using specific data readers:
gradlew "ofbiz --load-data readers=seed,seed-initial,ext"


HTH
Thanks and regards,
Aditya Sharma

On Mon, Jul 29, 2019 at 5:50 PM Jacques Le Roux <
[hidden email]> wrote:

> Hi Alexandre,
>
> One point from which you could start is the ecomseo webapp in the
> ecommerce component (plugin).
> There you will see that only the controller and web.xml are needed to
> reuse the ecommerce code while adjusting it for SEO needs.
>
> Also you can extend forms (look for "extends" in *form*.xml files)  and
> entities (look for "extend-entity" in *mode*.xml files)
>
> HTH
>
> Jacques
>
> Le 28/07/2019 à 20:44, Alexandre Beaulieu a écrit :
> > Hello, we are currently evaluating Ofbiz to use it as our development
> framework as well a use existing features as much as possible.
> >
> > Can anybody provide a custom component example (or guidelines) where a
> feature in an OOTB application such as party/partymgr is customised without
> having to copy most of the application in the component?
> >
> > For example, if we want to add some custom contact mechanism type to
> party, it seems overkill to have to copy the whole partymgr webapp/widget
> in the custom component just to customise that.
> > I'm missing a bit of the specifics to achieve that kind of customisation
> from the guidelines I found so far.
> >
> > So if anybody can point me to a good example or better guidelines, that
> would be great.
> >
> > Thanks.
> >
> >
> >
> >
>

[Alexandre Beaulieu]

Thanks Jacques!

On 2019/07/29 12:18:23, Jacques Le Roux <[hidden email]> wrote:

> Hi Alexandre,
>
> One point from which you could start is the ecomseo webapp in the ecommerce component (plugin).
> There you will see that only the controller and web.xml are needed to reuse the ecommerce code while adjusting it for SEO needs.
>
> Also you can extend forms (look for "extends" in *form*.xml files)  and entities (look for "extend-entity" in *mode*.xml files)
>
> HTH
>
> Jacques
>
> Le 28/07/2019 à 20:44, Alexandre Beaulieu a écrit :
> > Hello, we are currently evaluating Ofbiz to use it as our development framework as well a use existing features as much as possible.
> >
> > Can anybody provide a custom component example (or guidelines) where a feature in an OOTB application such as party/partymgr is customised without having to copy most of the application in the component?
> >
> > For example, if we want to add some custom contact mechanism type to party, it seems overkill to have to copy the whole partymgr webapp/widget in the custom component just to customise that.
> > I'm missing a bit of the specifics to achieve that kind of customisation from the guidelines I found so far.
> >
> > So if anybody can point me to a good example or better guidelines, that would be great.
> >
> > Thanks.
> >
> >
> >  
> >
>

[Alexandre Beaulieu]

Thanks Aditya!

On 2019/07/30 07:35:22, Aditya Sharma <[hidden email]> wrote:

> Hi Alexandre,
>
> Adding to it. Here are some references
>
> Extending form:
> http://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins/branches/release17.12/birt/widget/accounting/AccountingForms.xml
>
> Extending entity:
> http://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins/branches/release17.12/projectmgr/entitydef/entitymodel.xml
>
> For fields like Contact Mechanism, you can prepare data in your own
> component and load it using ext reader
>
> Doc on data readers:
> https://www.hotwaxsystems.com/ofbiz/ofbiz-data-setupdata-reader-best-practices-tutorial/
>
> List of existing  data readers can be found here:
> http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/framework/entity/config/entityengine.xml:92
> <http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/framework/entity/config/entityengine.xml>
> You can use ext reader for your custom data (recommended) or even you can
> have your own custom reader.
>
> Associate file with the reader:
> http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/applications/datamodel/ofbiz-component.xml
>
> Preparing data:
> http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/branches/release17.12/applications/datamodel/data/seed/PartySeedData.xml
>
> Command for loading data using specific data readers:
> gradlew "ofbiz --load-data readers=seed,seed-initial,ext"
>
>
> HTH
> Thanks and regards,
> Aditya Sharma
>
> On Mon, Jul 29, 2019 at 5:50 PM Jacques Le Roux <
> [hidden email]> wrote:
>
> > Hi Alexandre,
> >
> > One point from which you could start is the ecomseo webapp in the
> > ecommerce component (plugin).
> > There you will see that only the controller and web.xml are needed to
> > reuse the ecommerce code while adjusting it for SEO needs.
> >
> > Also you can extend forms (look for "extends" in *form*.xml files)  and
> > entities (look for "extend-entity" in *mode*.xml files)
> >
> > HTH
> >
> > Jacques
> >
> > Le 28/07/2019 à 20:44, Alexandre Beaulieu a écrit :
> > > Hello, we are currently evaluating Ofbiz to use it as our development
> > framework as well a use existing features as much as possible.
> > >
> > > Can anybody provide a custom component example (or guidelines) where a
> > feature in an OOTB application such as party/partymgr is customised without
> > having to copy most of the application in the component?
> > >
> > > For example, if we want to add some custom contact mechanism type to
> > party, it seems overkill to have to copy the whole partymgr webapp/widget
> > in the custom component just to customise that.
> > > I'm missing a bit of the specifics to achieve that kind of customisation
> > from the guidelines I found so far.
> > >
> > > So if anybody can point me to a good example or better guidelines, that
> > would be great.
> > >
> > > Thanks.
> > >
> > >
> > >
> > >
> >
>