OFBiz Service Documentation

[rohit369]

Hi All,

There is a complete documentation of all the Services that OFBiz exposes. Currently, there are around 2620 services. Its very difficult to exactly find out the service we need. For instance, createPartyPostalAddress internally calls createPartyContactMech & createPostalAddress. But createPartyContactMech internally again calls createContactMech. If we take this, creating an address will create a new ContactMech and then a PostalAddress.
This chain is not complete until we create an entry in PartyContactMech to link Party and ContactMech.
Looking at the above situation, is there any document which explains the service flow which are available out of box in the OFBiz package?
Please advice. Many thanks in advance.

Thanks & Regards,

Rohit

[Jacques Le Roux]

AFAIK no, this one is the most complicated IMO

Jacques

From: "rohit369" <[hidden email]>

> Hi All,
>
> There is a complete documentation of all the Services that OFBiz exposes.
> Currently, there are around 2620 services. Its very difficult to exactly
> find out the service we need. For instance, createPartyPostalAddress
> internally calls createPartyContactMech & createPostalAddress. But
> createPartyContactMech internally again calls createContactMech. If we take
> this, creating an address will create a new ContactMech and then a
> PostalAddress.
> This chain is not complete until we create an entry in PartyContactMech to
> link Party and ContactMech.
> Looking at the above situation, is there any document which explains the
> service flow which are available out of box in the OFBiz package?
> Please advice. Many thanks in advance.
>
> Thanks & Regards,
>
> Rohit
>
> --
> View this message in context: http://ofbiz.135035.n4.nabble.com/OFBiz-Service-Documentation-tp4634447.html
> Sent from the OFBiz - User mailing list archive at Nabble.com.

[Jacques Le Roux]

Ha, hold on, you have the artifactInfo https://demo-trunk.ofbiz.apache.org/webtools/control/ArtifactInfo (takes some time load, say
a min...)
Then look for createPartyPostalAddress as a service

Jacques

From: "Jacques Le Roux" <[hidden email]>

> AFAIK no, this one is the most complicated IMO
>
> Jacques
>
> From: "rohit369" <[hidden email]>
>> Hi All,
>>
>> There is a complete documentation of all the Services that OFBiz exposes.
>> Currently, there are around 2620 services. Its very difficult to exactly
>> find out the service we need. For instance, createPartyPostalAddress
>> internally calls createPartyContactMech & createPostalAddress. But
>> createPartyContactMech internally again calls createContactMech. If we take
>> this, creating an address will create a new ContactMech and then a
>> PostalAddress. This chain is not complete until we create an entry in PartyContactMech to
>> link Party and ContactMech. Looking at the above situation, is there any document which explains the
>> service flow which are available out of box in the OFBiz package?
>> Please advice. Many thanks in advance.
>>
>> Thanks & Regards,
>>
>> Rohit
>>
>> --
>> View this message in context: http://ofbiz.135035.n4.nabble.com/OFBiz-Service-Documentation-tp4634447.html
>> Sent from the OFBiz - User mailing list archive at Nabble.com.

[rohit369]

Hi Jacques,

Thanks a lot for the info. I also have this info on my local OFBiz instance.
I am curious to know few things here. Let me take an example. If I want to call a service to do a credit card transaction lets say "aimCCAuth" - This takes in orderPaymentPreference as one of the parameters. I can still do the transactions successfully just by passing a dummy orderPaymentPreference instance with no info in it.
However, the problem gets complicated when I want to call the "aimCCRefund" where the entire service is heavily dependent on orderPaymentPreference object because it retrieves the creditCard object from orderPaymentPreference object.
In the "aimCCAuth" service I had not bothered to save the credit card information in the DB. Now I dont know from where I can supply this info to the "aimCCRefund" service.

My problem here is, how to identify these per-requisites when I am calling these services? In this case, the document should ideally inform the developer to save certain information when calling "aimCCAuth" service in order to satisfy "aimCCRefund" service requirement.
Is there is a way to identify this in OFBiz for the developer?
Please help. Thanks a lot in advance.

Thanks & Regards,

Rohit

[Jacques Le Roux]

Sorry, I don't think so there are methods apart looking into code

Jacques

From: "rohit369" <[hidden email]>

> Hi Jacques,
>
> Thanks a lot for the info. I also have this info on my local OFBiz instance.
> I am curious to know few things here. Let me take an example. If I want to
> call a service to do a credit card transaction lets say "aimCCAuth" - This
> takes in orderPaymentPreference as one of the parameters. I can still do the
> transactions successfully just by passing a dummy orderPaymentPreference
> instance with no info in it.
> However, the problem gets complicated when I want to call the "aimCCRefund"
> where the entire service is heavily dependent on orderPaymentPreference
> object because it retrieves the creditCard object from
> orderPaymentPreference object.
> In the "aimCCAuth" service I had not bothered to save the credit card
> information in the DB. Now I dont know from where I can supply this info to
> the "aimCCRefund" service.
>
> My problem here is, how to identify these per-requisites when I am calling
> these services? In this case, the document should ideally inform the
> developer to save certain information when calling "aimCCAuth" service in
> order to satisfy "aimCCRefund" service requirement.
> Is there is a way to identify this in OFBiz for the developer?
> Please help. Thanks a lot in advance.
>
> Thanks & Regards,
>
> Rohit
>
> --
> View this message in context: http://ofbiz.135035.n4.nabble.com/OFBiz-Service-Documentation-tp4634447p4634471.html
> Sent from the OFBiz - User mailing list archive at Nabble.com.