You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by Christopher Snow <sn...@snowconsulting.co.uk> on 2010/04/14 22:36:34 UTC

Providing users with help

As a user that is relatively new to the setup of ofbiz, I find that it 
is quite time consuming to work out the meaning of various settings.  
For example, in setting up a product store, the purpose of the field 
"Check Inventory" doesn't really mean much to me.  However, looking 
through the 'Manager Reference : Catalog' by Undersun, I see the 
description for Check Inventory as:

"This determines whether the system checks inventory levels when 
processing an order. If inventory IS checked (Y),
the item cannot be ordered or rather the order cannot be fulfilled if 
there is insufficient QOH or ATP. If Inventory is not
checked, however, the order may be accepted but items not available will 
be processed as a back-order. You need a
system in place to track, replenish and fulfill back-ordered items if 
you set this flag to N."

This description is exactly what I need to make a decision on the 
setting for my requirements.  Ideally, this type of field information 
would be available as a popup (perhaps by hovering a cursor over a 
question mark icon) and also in the Help screen (a popup would be a way 
for a user to get a quick description of a fields purpose, yet the help 
could provide workflow type information).

Question 1: is there any merit in the popup type approach (perhaps 
utilising the form tooltip attribute)?
Question 2: until a popup approach is implemented (if ever), I would he 
happy to start copying the field descriptions from the 'Manager 
Reference' guides to the Help screens - if the Manager Reference 
copyright permits it.  Can anyone provide any feedback on this?

Many thanks,

Chris



Re: Providing users with help

Posted by Christopher Snow <sn...@snowconsulting.co.uk>.
Hi Hans,

JIRA created - https://issues.apache.org/jira/browse/OFBIZ-3702

Many thanks,

Chris

Hans Bakker wrote:
> I do not think so....but as usual can be added of course.....
>
> On Thu, 2010-04-15 at 07:07 +0100, Christopher Snow wrote:
>   
>> Hi Hans,
>>
>> Will this method using entity field description support i18n?
>>
>> Many thanks,
>>
>> Chris
>>
>> Hans Bakker wrote:
>>     
>>> Hi Chris,
>>>
>>> the most ideal thing to make this happen if this description was first
>>> copied into the data model in the entitymodel.xml files in the
>>> description attribute.
>>>
>>> Then this description could be shown either in the help screens for the
>>> fields shown in the related forms or as a mouseover popup from within
>>> the screens.
>>>
>>> Regards,
>>> Hans
>>>
>>>
>>> On Wed, 2010-04-14 at 21:36 +0100, Christopher Snow wrote:
>>>   
>>>       
>>>> As a user that is relatively new to the setup of ofbiz, I find that it 
>>>> is quite time consuming to work out the meaning of various settings.  
>>>> For example, in setting up a product store, the purpose of the field 
>>>> "Check Inventory" doesn't really mean much to me.  However, looking 
>>>> through the 'Manager Reference : Catalog' by Undersun, I see the 
>>>> description for Check Inventory as:
>>>>
>>>> "This determines whether the system checks inventory levels when 
>>>> processing an order. If inventory IS checked (Y),
>>>> the item cannot be ordered or rather the order cannot be fulfilled if 
>>>> there is insufficient QOH or ATP. If Inventory is not
>>>> checked, however, the order may be accepted but items not available will 
>>>> be processed as a back-order. You need a
>>>> system in place to track, replenish and fulfill back-ordered items if 
>>>> you set this flag to N."
>>>>
>>>> This description is exactly what I need to make a decision on the 
>>>> setting for my requirements.  Ideally, this type of field information 
>>>> would be available as a popup (perhaps by hovering a cursor over a 
>>>> question mark icon) and also in the Help screen (a popup would be a way 
>>>> for a user to get a quick description of a fields purpose, yet the help 
>>>> could provide workflow type information).
>>>>
>>>> Question 1: is there any merit in the popup type approach (perhaps 
>>>> utilising the form tooltip attribute)?
>>>> Question 2: until a popup approach is implemented (if ever), I would he 
>>>> happy to start copying the field descriptions from the 'Manager 
>>>> Reference' guides to the Help screens - if the Manager Reference 
>>>> copyright permits it.  Can anyone provide any feedback on this?
>>>>
>>>> Many thanks,
>>>>
>>>> Chris
>>>>
>>>>
>>>>     
>>>>         
>>
>>
>>
>>
>>
>>     


Re: Providing users with help

Posted by Hans Bakker <ma...@antwebsystems.com>.
I do not think so....but as usual can be added of course.....

On Thu, 2010-04-15 at 07:07 +0100, Christopher Snow wrote:
> Hi Hans,
> 
> Will this method using entity field description support i18n?
> 
> Many thanks,
> 
> Chris
> 
> Hans Bakker wrote:
> > Hi Chris,
> >
> > the most ideal thing to make this happen if this description was first
> > copied into the data model in the entitymodel.xml files in the
> > description attribute.
> >
> > Then this description could be shown either in the help screens for the
> > fields shown in the related forms or as a mouseover popup from within
> > the screens.
> >
> > Regards,
> > Hans
> >
> >
> > On Wed, 2010-04-14 at 21:36 +0100, Christopher Snow wrote:
> >   
> >> As a user that is relatively new to the setup of ofbiz, I find that it 
> >> is quite time consuming to work out the meaning of various settings.  
> >> For example, in setting up a product store, the purpose of the field 
> >> "Check Inventory" doesn't really mean much to me.  However, looking 
> >> through the 'Manager Reference : Catalog' by Undersun, I see the 
> >> description for Check Inventory as:
> >>
> >> "This determines whether the system checks inventory levels when 
> >> processing an order. If inventory IS checked (Y),
> >> the item cannot be ordered or rather the order cannot be fulfilled if 
> >> there is insufficient QOH or ATP. If Inventory is not
> >> checked, however, the order may be accepted but items not available will 
> >> be processed as a back-order. You need a
> >> system in place to track, replenish and fulfill back-ordered items if 
> >> you set this flag to N."
> >>
> >> This description is exactly what I need to make a decision on the 
> >> setting for my requirements.  Ideally, this type of field information 
> >> would be available as a popup (perhaps by hovering a cursor over a 
> >> question mark icon) and also in the Help screen (a popup would be a way 
> >> for a user to get a quick description of a fields purpose, yet the help 
> >> could provide workflow type information).
> >>
> >> Question 1: is there any merit in the popup type approach (perhaps 
> >> utilising the form tooltip attribute)?
> >> Question 2: until a popup approach is implemented (if ever), I would he 
> >> happy to start copying the field descriptions from the 'Manager 
> >> Reference' guides to the Help screens - if the Manager Reference 
> >> copyright permits it.  Can anyone provide any feedback on this?
> >>
> >> Many thanks,
> >>
> >> Chris
> >>
> >>
> >>     
> 
> 
> 
> 
> 
> 
> 
-- 
Ofbiz on twitter: http://twitter.com/apache_ofbiz
Myself on twitter: http://twitter.com/hansbak
Antwebsystems.com: Quality services for competitive rates.


Re: Providing users with help

Posted by Christopher Snow <sn...@snowconsulting.co.uk>.
Hi Hans,

Will this method using entity field description support i18n?

Many thanks,

Chris

Hans Bakker wrote:
> Hi Chris,
>
> the most ideal thing to make this happen if this description was first
> copied into the data model in the entitymodel.xml files in the
> description attribute.
>
> Then this description could be shown either in the help screens for the
> fields shown in the related forms or as a mouseover popup from within
> the screens.
>
> Regards,
> Hans
>
>
> On Wed, 2010-04-14 at 21:36 +0100, Christopher Snow wrote:
>   
>> As a user that is relatively new to the setup of ofbiz, I find that it 
>> is quite time consuming to work out the meaning of various settings.  
>> For example, in setting up a product store, the purpose of the field 
>> "Check Inventory" doesn't really mean much to me.  However, looking 
>> through the 'Manager Reference : Catalog' by Undersun, I see the 
>> description for Check Inventory as:
>>
>> "This determines whether the system checks inventory levels when 
>> processing an order. If inventory IS checked (Y),
>> the item cannot be ordered or rather the order cannot be fulfilled if 
>> there is insufficient QOH or ATP. If Inventory is not
>> checked, however, the order may be accepted but items not available will 
>> be processed as a back-order. You need a
>> system in place to track, replenish and fulfill back-ordered items if 
>> you set this flag to N."
>>
>> This description is exactly what I need to make a decision on the 
>> setting for my requirements.  Ideally, this type of field information 
>> would be available as a popup (perhaps by hovering a cursor over a 
>> question mark icon) and also in the Help screen (a popup would be a way 
>> for a user to get a quick description of a fields purpose, yet the help 
>> could provide workflow type information).
>>
>> Question 1: is there any merit in the popup type approach (perhaps 
>> utilising the form tooltip attribute)?
>> Question 2: until a popup approach is implemented (if ever), I would he 
>> happy to start copying the field descriptions from the 'Manager 
>> Reference' guides to the Help screens - if the Manager Reference 
>> copyright permits it.  Can anyone provide any feedback on this?
>>
>> Many thanks,
>>
>> Chris
>>
>>
>>     








Re: Providing users with help

Posted by David E Jones <de...@me.com>.
They are available under the Apache License 2.0 just like everything else in confluence.

-David


On Apr 14, 2010, at 10:10 PM, chris snow wrote:

> Hi Hans, do you know if the Manager References are protected by copyright?
> 
> On 15 Apr 2010 01:57, "Hans Bakker" <ma...@antwebsystems.com> wrote:
> 
> Hi Chris,
> 
> the most ideal thing to make this happen if this description was first
> copied into the data model in the entitymodel.xml files in the
> description attribute.
> 
> Then this description could be shown either in the help screens for the
> fields shown in the related forms or as a mouseover popup from within
> the screens.
> 
> Regards,
> Hans
> 
> 
> 
> On Wed, 2010-04-14 at 21:36 +0100, Christopher Snow wrote:
>> As a user that is relatively new to t...
> --
> Ofbiz on twitter: http://twitter.com/apache_ofbiz
> Myself on twitter: http://twitter.com/hansbak
> Antwebsystems.com: Quality services for competitive rates.


Re: Providing users with help

Posted by chris snow <ch...@googlemail.com>.
Hi Hans, do you know if the Manager References are protected by copyright?

On 15 Apr 2010 01:57, "Hans Bakker" <ma...@antwebsystems.com> wrote:

Hi Chris,

the most ideal thing to make this happen if this description was first
copied into the data model in the entitymodel.xml files in the
description attribute.

Then this description could be shown either in the help screens for the
fields shown in the related forms or as a mouseover popup from within
the screens.

Regards,
Hans



On Wed, 2010-04-14 at 21:36 +0100, Christopher Snow wrote:
> As a user that is relatively new to t...
--
Ofbiz on twitter: http://twitter.com/apache_ofbiz
Myself on twitter: http://twitter.com/hansbak
Antwebsystems.com: Quality services for competitive rates.

Re: Providing users with help

Posted by Hans Bakker <ma...@antwebsystems.com>.
Hi Chris,

the most ideal thing to make this happen if this description was first
copied into the data model in the entitymodel.xml files in the
description attribute.

Then this description could be shown either in the help screens for the
fields shown in the related forms or as a mouseover popup from within
the screens.

Regards,
Hans


On Wed, 2010-04-14 at 21:36 +0100, Christopher Snow wrote:
> As a user that is relatively new to the setup of ofbiz, I find that it 
> is quite time consuming to work out the meaning of various settings.  
> For example, in setting up a product store, the purpose of the field 
> "Check Inventory" doesn't really mean much to me.  However, looking 
> through the 'Manager Reference : Catalog' by Undersun, I see the 
> description for Check Inventory as:
> 
> "This determines whether the system checks inventory levels when 
> processing an order. If inventory IS checked (Y),
> the item cannot be ordered or rather the order cannot be fulfilled if 
> there is insufficient QOH or ATP. If Inventory is not
> checked, however, the order may be accepted but items not available will 
> be processed as a back-order. You need a
> system in place to track, replenish and fulfill back-ordered items if 
> you set this flag to N."
> 
> This description is exactly what I need to make a decision on the 
> setting for my requirements.  Ideally, this type of field information 
> would be available as a popup (perhaps by hovering a cursor over a 
> question mark icon) and also in the Help screen (a popup would be a way 
> for a user to get a quick description of a fields purpose, yet the help 
> could provide workflow type information).
> 
> Question 1: is there any merit in the popup type approach (perhaps 
> utilising the form tooltip attribute)?
> Question 2: until a popup approach is implemented (if ever), I would he 
> happy to start copying the field descriptions from the 'Manager 
> Reference' guides to the Help screens - if the Manager Reference 
> copyright permits it.  Can anyone provide any feedback on this?
> 
> Many thanks,
> 
> Chris
> 
> 
-- 
Ofbiz on twitter: http://twitter.com/apache_ofbiz
Myself on twitter: http://twitter.com/hansbak
Antwebsystems.com: Quality services for competitive rates.