OFBiz › OFBiz - User

entity-one

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

13 messages Options

myofbiz

entity-one

Hi all,
Iam trying to create a user(ie store the data of a user). I have questions regarding this....please I would be obliged if someone clears my doubts
I have an entity in entitymodel.xml.
That entity has four fields in it.(There is no primary key in it for now....)
In data dir I guess there should be a xml file starting with entity-engine-xml--What exactly is the use of this file and what data do we write in it and what is seed data(is it the data we see in our dropdown lists?)
Is entitygroup.xml mantatory or optional.
Iam refering the "example" application for this..
What does entity-one tag means ...
<entity-one entity-name="Example" value-name="example"/>
What does:
use-when="example==null" mean?
when example is null it targets to"createExample" in controller.xml
and createExample in controller points to service name=createExample in services.xml which is:

<service name="createExample" default-entity-name="Example" engine="entity-auto" invoke="create" auth="true">
<description>Create a Example</description>
<permission-service service-name="exampleGenericPermission" main-action="CREATE"/>
<auto-attributes include="pk" mode="OUT" optional="false"/>
<auto-attributes include="nonpk" mode="IN" optional="true"/>
<override name="exampleTypeId" optional="false"/>
<override name="statusId" optional="false"/>
<override name="exampleName" optional="false"/>
</service>

Iam not clear with this service can someone explain this in detail please

Thankyou very much..

brajeshpatel

Re: entity-one

Hi Adithi,
First you can read OFBiz framework file that is simple-methods.xsd, this
file give more knowledge about simple method tag.

On Mon, Sep 29, 2008 at 7:43 PM, adithi agarwal <[hidden email]>wrote:

> Hi all,
> Iam trying to create a user(ie store the data of a user). I have questions
> regarding this....please I would be obliged if someone clears my doubts
> I have an entity in entitymodel.xml.
> That entity has four fields in it.(There is no primary key in it for
> now....)
> In data dir I guess there should be a xml file starting with
> entity-engine-xml--What exactly is the use of this file and what data do we
> write in it and what is seed data(is it the data we see in our dropdown
> lists?)
> Is entitygroup.xml mantatory or optional.
> Iam refering the "example" application for this..
> What does entity-one tag means ...
> <entity-one entity-name="Example" value-name="example"/>
> What does:
> use-when="example==null" mean?
> when example is null it targets to"createExample" in controller.xml
> and createExample in controller points to service name=createExample in
> services.xml which is:
>
> <service name="createExample" default-entity-name="Example"
> engine="entity-auto" invoke="create" auth="true">
> <description>Create a Example</description>
> <permission-service service-name="exampleGenericPermission"
> main-action="CREATE"/>
> <auto-attributes include="pk" mode="OUT" optional="false"/>
> <auto-attributes include="nonpk" mode="IN" optional="true"/>
> <override name="exampleTypeId" optional="false"/>
> <override name="statusId" optional="false"/>
> <override name="exampleName" optional="false"/>
> </service>
>
> Iam not clear with this service can someone explain this in detail please
>
> Thankyou very much..
>
>
>

Divesh Dutta

Re: entity-one

In reply to this post by myofbiz

hi adithi,
well you have asked lots of question.....i am trying to answer them one
by one.

<entity-one entity-name="Example" value-name="example"/>
this tag fetches generic value object for entity Example from database and put it in a value-name"example".This tag is used when we make service implementation for updating or deleting.we get single generic value object of entity to be deleted or updated.

for example look at this :
<simple-method method-name="updatePracticeParty" short-description="update a Party">
<entity-one entity-name="Party" value-name="lookedUpValue"/>
<set-nonpk-fields map-name="parameters" value-name="lookedUpValue"/>
<store-value value-name="lookedUpValue"/>
<log level="info" message="=======Party record updated for partyId=====${lookedUpValue.partyId}"/>
</simple-method>

here single generic value object of Party entity is fetched from database and placed in "lookedupvalue".then all non primary key we give from forms are stored in "lookedupvalue".that means "lookedupvalue" contains field which we wanted to update and other fields which are updated on.And then <store-value> tag store this fields in database.

Thanks And Regards
Divesh Dutta
Hotwax Media Pvt Ltd.

adithi agarwal wrote:

> Hi all,
> Iam trying to create a user(ie store the data of a user). I have questions regarding this....please I would be obliged if someone clears my doubts
> I have an entity in entitymodel.xml.
> That entity has four fields in it.(There is no primary key in it for now....)
> In data dir I guess there should be a xml file starting with entity-engine-xml--What exactly is the use of this file and what data do we write in it and what is seed data(is it the data we see in our dropdown lists?)
> Is entitygroup.xml mantatory or optional.
> Iam refering the "example" application for this..
> What does entity-one tag means ...
> <entity-one entity-name="Example" value-name="example"/>
> What does:
> use-when="example==null" mean?
> when example is null it targets to"createExample" in controller.xml
> and createExample in controller points to service name=createExample in services.xml which is:
>
> <service name="createExample" default-entity-name="Example" engine="entity-auto" invoke="create" auth="true">
> <description>Create a Example</description>
> <permission-service service-name="exampleGenericPermission" main-action="CREATE"/>
> <auto-attributes include="pk" mode="OUT" optional="false"/>
> <auto-attributes include="nonpk" mode="IN" optional="true"/>
> <override name="exampleTypeId" optional="false"/>
> <override name="statusId" optional="false"/>
> <override name="exampleName" optional="false"/>
> </service>
>
> Iam not clear with this service can someone explain this in detail please
>
> Thankyou very much..
>
>
>
>

Divesh Dutta

Re: entity-one

In reply to this post by myofbiz

hi adithi,
you may also visit this link :
http://ofbiz.apache.org/dtds/simple-methods.xsd
this contains function of entity one.this may help you.
Thanks And Regards
Divesh Dutta
Hotwax Media Pvt Ltd.

adithi agarwal wrote:

Divesh Dutta

Re: entity-one

In reply to this post by myofbiz

<service name="createExample" default-entity-name="Example"
engine="entity-auto" invoke="create" auth="true">
<description>Create a Example</description>
<permission-service service-name="exampleGenericPermission"
main-action="CREATE"/>
<auto-attributes include="pk" mode="OUT" optional="false"/>
<auto-attributes include="nonpk" mode="IN" optional="true"/>
<override name="exampleTypeId" optional="false"/>
<override name="statusId" optional="false"/>
<override name="exampleName" optional="false"/>
</service>

1)This is service definition.you dont need override tag here.if you
implement any interface just like when we implement any class in
java,then you need override tag.

2)engine="entity-auto":: reason for using this tag is given below in
this link:
http://www.nabble.com/The-fancy-new-entity-auto-service-execution-engine-td18674040.html

3)engine="entity-auto" invoke="create" play the role for creating the
records for the default-entity "Example."

4) <auto-attributes include="pk" mode="OUT" optional="false"/>
<auto-attributes include="nonpk" mode="IN" optional="true"/>
This tag automatically includes primary key and non primary key of default-entity-name="Example"
Additional tags can be added by:
<attribute name="firstName" mode="IN" type="String" optional="false"/>
5)<auto-attributes tag are used only in service definition.

6)Please refer to practice application.I have already given you the link.most of the answer of your question
are given over there.

Thanks And Regards

Divesh Dutta

Hotwax Media Pvt Ltd.

myofbiz

Re: entity-one

In reply to this post by myofbiz

Hi Divesh..

Thankyou for your patience.
I think the explanation you have given is for updating the existing data.
I am not yet clear with the storing of data(creation)..
Can you please say something about that.( I dint understand the service fro create)

Thankyou very much..

----- Original Message ----
From: Divesh Dutta <[hidden email]>
To: [hidden email]
Sent: Monday, September 29, 2008 7:31:49 AM
Subject: Re: entity-one

hi adithi,
well you have asked lots of question.....i am trying to answer them one
by one.

<entity-one entity-name="Example" value-name="example"/>
this tag fetches generic value object for entity Example from database and put it in a value-name"example".This tag is used when we make service implementation for updating or deleting.we get single generic value object of entity to be deleted or updated.

for example look at this :
<simple-method method-name="updatePracticeParty" short-description="update a Party">
<entity-one entity-name="Party" value-name="lookedUpValue"/>
<set-nonpk-fields map-name="parameters" value-name="lookedUpValue"/>
<store-value value-name="lookedUpValue"/>
<log level="info" message="=======Party record updated for partyId=====${lookedUpValue.partyId}"/>
</simple-method>

here single generic value object of Party entity is fetched from database and placed in "lookedupvalue".then all non primary key we give from forms are stored in "lookedupvalue".that means "lookedupvalue" contains field which we wanted to update and other fields which are updated on.And then <store-value> tag store this fields in database.

Thanks And Regards
Divesh Dutta
Hotwax Media Pvt Ltd.

adithi agarwal wrote:

myofbiz

Re: entity-one

In reply to this post by myofbiz

Thankyou so much Divesh..it is very helpful and yes I ll go through the practice application

----- Original Message ----
From: Divesh Dutta <[hidden email]>
To: [hidden email]
Sent: Monday, September 29, 2008 7:57:59 AM
Subject: Re: entity-one

<service name="createExample" default-entity-name="Example"
engine="entity-auto" invoke="create" auth="true">
<description>Create a Example</description>
<permission-service service-name="exampleGenericPermission"
main-action="CREATE"/>
<auto-attributes include="pk" mode="OUT" optional="false"/>
<auto-attributes include="nonpk" mode="IN" optional="true"/>
<override name="exampleTypeId" optional="false"/>
<override name="statusId" optional="false"/>
<override name="exampleName" optional="false"/>
</service>

1)This is service definition.you dont need override tag here.if you
implement any interface just like when we implement any class in
java,then you need override tag.

2)engine="entity-auto":: reason for using this tag is given below in
this link:
http://www.nabble.com/The-fancy-new-entity-auto-service-execution-engine-td18674040.html

3)engine="entity-auto" invoke="create" play the role for creating the
records for the default-entity "Example."

4) <auto-attributes include="pk" mode="OUT" optional="false"/>
<auto-attributes include="nonpk" mode="IN" optional="true"/>
This tag automatically includes primary key and non primary key of default-entity-name="Example"
Additional tags can be added by:
<attribute name="firstName" mode="IN" type="String" optional="false"/>
5)<auto-attributes tag are used only in service definition.

6)Please refer to practice application.I have already given you the link.most of the answer of your question
are given over there.

Thanks And Regards

Divesh Dutta

Hotwax Media Pvt Ltd.

Pranay Pandey-2

Re: entity-one

In reply to this post by myofbiz

Hello Aditi,

This will really help you, If you will learn working in OFBiz with
steps not in one shot.

Please refer this document for helping yourself : http://docs.ofbiz.org/display/OFBIZ/OFBiz+Beginner%27s+Development+Guide+Using+Practice+Application

This will really help you a lot.

Thanks & Regards
--
Pranay Pandey
HotWax Media Pvt. Ltd.
[hidden email]
www.hotwaxmedia.com

Office : +917314093684
Direct : +919826035576

On Sep 29, 2008, at 8:32 PM, adithi agarwal wrote:

> Hi Divesh..
>
> Thankyou for your patience.
> I think the explanation you have given is for updating the existing
> data.
> I am not yet clear with the storing of data(creation)..
> Can you please say something about that.( I dint understand the
> service fro create)
>
> Thankyou very much..
>
>
>
> ----- Original Message ----
> From: Divesh Dutta <[hidden email]>
> To: [hidden email]
> Sent: Monday, September 29, 2008 7:31:49 AM
> Subject: Re: entity-one
>
> hi adithi,
> well you have asked lots of question.....i am trying to answer them
> one
> by one.
>
> <entity-one entity-name="Example" value-name="example"/>
> this tag fetches generic value object for entity Example from
> database and put it in a value-name"example".This tag is used when
> we make service implementation for updating or deleting.we get
> single generic value object of entity to be deleted or updated.
>
> for example look at this :
> <simple-method method-name="updatePracticeParty" short-
> description="update a Party">
> <entity-one entity-name="Party" value-name="lookedUpValue"/>
> <set-nonpk-fields map-name="parameters" value-
> name="lookedUpValue"/>
> <store-value value-name="lookedUpValue"/>
> <log level="info" message="=======Party record updated for
> partyId=====${lookedUpValue.partyId}"/>
> </simple-method>
>
> here single generic value object of Party entity is fetched from
> database and placed in "lookedupvalue".then all non primary key we
> give from forms are stored in "lookedupvalue".that means
> "lookedupvalue" contains field which we wanted to update and other
> fields which are updated on.And then <store-value> tag store this
> fields in database.
>
> Thanks And Regards
> Divesh Dutta
> Hotwax Media Pvt Ltd.
>
>
>
>
> adithi agarwal wrote:
>> Hi all,
>> Iam trying to create a user(ie store the data of a user). I have
>> questions regarding this....please I would be obliged if someone
>> clears my doubts
>> I have an entity in entitymodel.xml.
>> That entity has four fields in it.(There is no primary key in it
>> for now....)
>> In data dir I guess there should be a xml file starting with entity-
>> engine-xml--What exactly is the use of this file and what data do
>> we write in it and what is seed data(is it the data we see in our
>> dropdown lists?)
>> Is entitygroup.xml mantatory or optional.
>> Iam refering the "example" application for this..
>> What does entity-one tag means ...
>> <entity-one entity-name="Example" value-name="example"/>
>> What does:
>> use-when="example==null" mean?
>> when example is null it targets to"createExample" in controller.xml
>> and createExample in controller points to service
>> name=createExample in services.xml which is:
>>
>> <service name="createExample" default-entity-name="Example"
>> engine="entity-auto" invoke="create" auth="true">
>> <description>Create a Example</description>
>> <permission-service service-name="exampleGenericPermission"
>> main-action="CREATE"/>
>> <auto-attributes include="pk" mode="OUT" optional="false"/>
>> <auto-attributes include="nonpk" mode="IN" optional="true"/>
>> <override name="exampleTypeId" optional="false"/>
>> <override name="statusId" optional="false"/>
>> <override name="exampleName" optional="false"/>
>> </service>
>>
>> Iam not clear with this service can someone explain this in detail
>> please
>>
>> Thankyou very much..
>>
>>
>>
>>
>
>
>

myofbiz

Re: entity-one

In reply to this post by myofbiz

Hi
In practice application its written that we use groovy files or bsh files...So do these files help in saving and displaying data from database.Is Beanshell or Groovy a suggestable one...For a simple application to create,display,update and delete data,is groovy or Beanshell files required...(or Are widgets are sufficient)

Thanks

----- Original Message ----
From: Pranay Pandey <[hidden email]>
To: [hidden email]
Sent: Monday, September 29, 2008 8:12:37 AM
Subject: Re: entity-one

Hello Aditi,

This will really help you, If you will learn working in OFBiz with
steps not in one shot.

Please refer this document for helping yourself : http://docs.ofbiz.org/display/OFBIZ/OFBiz+Beginner%27s+Development+Guide+Using+Practice+Application

This will really help you a lot.

Thanks & Regards
--
Pranay Pandey
HotWax Media Pvt. Ltd.
[hidden email]
www.hotwaxmedia.com

Office : +917314093684
Direct : +919826035576

On Sep 29, 2008, at 8:32 PM, adithi agarwal wrote:

Mridul Pathak-2

Re: entity-one

In reply to this post by Divesh Dutta

Hi Divesh, Aditi
For #1 I would just like to add that its not necessary to use override
tags with interfaces only. You can obviously use them when you use
<auto-attribute> tag in you service definition. So the use of <override>
tag in this service definition is completely fine and as this service
definition comes from OFBiz itself, it can't be wrong :). The use of
<override> tag is to override the behavior of a field that comes from an
interface or <auto-attribute> tag or some other implemented service, in our
service definition.

On Mon, Sep 29, 2008 at 8:27 PM, Divesh Dutta
<[hidden email]>wrote:

> <service name="createExample" default-entity-name="Example"
> engine="entity-auto" invoke="create" auth="true">
> <description>Create a Example</description>
> <permission-service service-name="exampleGenericPermission"
> main-action="CREATE"/>
> <auto-attributes include="pk" mode="OUT" optional="false"/>
> <auto-attributes include="nonpk" mode="IN" optional="true"/>
> <override name="exampleTypeId" optional="false"/>
> <override name="statusId" optional="false"/>
> <override name="exampleName" optional="false"/>
> </service>
>
> 1)This is service definition.you dont need override tag here.if you
> implement any interface just like when we implement any class in java,then
> you need override tag.
>
> 2)engine="entity-auto":: reason for using this tag is given below in this
> link:
>
> http://www.nabble.com/The-fancy-new-entity-auto-service-execution-engine-td18674040.html
>
> 3)engine="entity-auto" invoke="create" play the role for creating the
> records for the default-entity "Example."
>
> 4) <auto-attributes include="pk" mode="OUT" optional="false"/>
> <auto-attributes include="nonpk" mode="IN" optional="true"/>
> This tag automatically includes primary key and non primary key of
> default-entity-name="Example"
> Additional tags can be added by:
> <attribute name="firstName" mode="IN" type="String" optional="false"/>
> 5)<auto-attributes tag are used only in service definition.
>
> 6)Please refer to practice application.I have already given you the
> link.most of the answer of your question are given over there.
>
>
>
> Thanks And Regards
>
> Divesh Dutta
>
> Hotwax Media Pvt Ltd.
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

--
Thanks & Regards
Mridul Pathak
Hotwax Media
http://www.hotwaxmedia.com
[hidden email]

Surya Kusumakar-3

Re: entity-one

In reply to this post by Divesh Dutta

Hello Adithi,
Ofbiz best practice for performing CRUD operations is to write services
and yes we can use Groovy for creating, updating ,retrieving and
deleting data i.e for data preparation.Using Groovy we can get data from
the database on the fly.
---
Thanks and Regards
Surya Kusumakar
HotwaxMedia Pvt Ltd.
www.hotwaxmedia.com

Divesh Dutta wrote:

> <service name="createExample" default-entity-name="Example"
> engine="entity-auto" invoke="create" auth="true">
> <description>Create a Example</description>
> <permission-service service-name="exampleGenericPermission"
> main-action="CREATE"/>
> <auto-attributes include="pk" mode="OUT" optional="false"/>
> <auto-attributes include="nonpk" mode="IN" optional="true"/>
> <override name="exampleTypeId" optional="false"/>
> <override name="statusId" optional="false"/>
> <override name="exampleName" optional="false"/>
> </service>
>
> 1)This is service definition.you dont need override tag here.if you
> implement any interface just like when we implement any class in
> java,then you need override tag.
>
> 2)engine="entity-auto":: reason for using this tag is given below in
> this link:
> http://www.nabble.com/The-fancy-new-entity-auto-service-execution-engine-td18674040.html
>
>
> 3)engine="entity-auto" invoke="create" play the role for creating the
> records for the default-entity "Example."
>
> 4) <auto-attributes include="pk" mode="OUT" optional="false"/>
> <auto-attributes include="nonpk" mode="IN" optional="true"/>
> This tag automatically includes primary key and non primary key
> of default-entity-name="Example"
> Additional tags can be added by:
> <attribute name="firstName" mode="IN" type="String" optional="false"/>
> 5)<auto-attributes tag are used only in service definition.
>
> 6)Please refer to practice application.I have already given you the
> link.most of the answer of your question are given over there.
>
>
> Thanks And Regards
>
> Divesh Dutta
>
> Hotwax Media Pvt Ltd.
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

awdesh parihar

Re: entity-one

Hello Adithi ,

Now in ofbiz we are using groovy instead of bsh , we use groovy when there
is need to prepare more complex data(like mathematical operation ) .

We can perform CRUD operation without groovy file unless there is no need of
complex data preparation .

--
--
Thanks and Regards
Awdesh Singh Parihar
HotwaxMedia Pvt Ltd.
www.hotwaxmedia.com

Surya Kusumakar-3

Re: entity-one

Hello Adithi ,
To know more about data preparation logic and data presentation logic
you can visit following link :
http://docs.ofbiz.org/display/OFBADMIN/Best+Practices+Guide
--
Thanks and Regards
Surya Kusumakar
HotwaxMedia Pvt Ltd.
www.hotwaxmedia.com

awdesh parihar wrote:
> Hello Adithi ,
>
> Now in ofbiz we are using groovy instead of bsh , we use groovy when there
> is need to prepare more complex data(like mathematical operation ) .
>
> We can perform CRUD operation without groovy file unless there is no need of
> complex data preparation .
>
>