You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by "chris snow (JIRA)" <ji...@apache.org> on 2010/09/19 23:48:34 UTC

[jira] Created: (OFBIZ-3949) Better RoleType Documentation

Better RoleType Documentation
-----------------------------

                 Key: OFBIZ-3949
                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
             Project: OFBiz
          Issue Type: Improvement
          Components: commonext/setup
            Reporter: chris snow


This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12912633#action_12912633 ] 

chris snow commented on OFBIZ-3949:
-----------------------------------

The documentation I'm doing on RoleType is proving to be very insightful.

The more I document, the more I realise that it is impossible to setup Roles without documention.  For example the following roles are defined in UserDemoData.xml in 10.04:

{code:xml} 
<PartyRole partyId="admin" roleTypeId="BUYER"/>
<PartyRole partyId="admin" roleTypeId="MANAGER"/>
<PartyRole partyId="admin" roleTypeId="ORDER_CLERK"/>
<PartyRole partyId="admin" roleTypeId="SHIPMENT_CLERK"/>
{code}

So far, I have ascertained that:

BUYER - has no influence in ofbiz, except for labelling parties.  E.g. admin is a BUYER
MANAGER - will give the admin user extended POS and WebPOS permissions
ORDER_CLERK - has no influence in ofbiz, except for labelling parties.  E.g. admin is an ORDER_CLERK
SHIPMENT_CLERK - will cause the Order Delivery Schedule Notification service to send emails to addresses of all parties having the SHIPMENT_CLERK role

Interesting facts!

Feedback welcome - good and bad...

Many thanks,

Chris


> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12912293#action_12912293 ] 

chris snow commented on OFBIZ-3949:
-----------------------------------

1st comment to get the ball rolling! - the table's first column showing the RoleType is not required as the section header shows the RoleType

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow updated OFBIZ-3949:
------------------------------

    Attachment:     (was: roletype.xml)

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow updated OFBIZ-3949:
------------------------------

    Attachment: roletype.xml
                roletype.pdf

Example RoleType documentation.

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12912369#action_12912369 ] 

chris snow commented on OFBIZ-3949:
-----------------------------------

Thanks for the feedback BJ.

I will add a section at the start of the document to show the hierarchy - maybe a tree if it isn't too big.  I'll also get the related revision number in.

Cheers,

Chris

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow updated OFBIZ-3949:
------------------------------

    Attachment:     (was: roletype.pdf)

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (OFBIZ-3949) Better RoleType Documentation

Posted by "BJ Freeman (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12912298#action_12912298 ] 

BJ Freeman commented on OFBIZ-3949:
-----------------------------------

will accelerate the web tools code so you can look it up in the web tools.
thinking of a drop down that list all the roles types then it will search the services,  mini lang, widget, and FTL for them.
as a patch it should be able to be used on 4.0,9.04 10.4, and trunk.


> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow updated OFBIZ-3949:
------------------------------

    Attachment: roletype.pdf
                roletype.xml

Amended to show ofbiz version for RoleType and RoleType hierarchy.

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.pdf, roletype.xml, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (OFBIZ-3949) Better RoleType Documentation

Posted by "chris snow (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow updated OFBIZ-3949:
------------------------------

    Attachment: roletype.xml
                roletype.pdf

> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (OFBIZ-3949) Better RoleType Documentation

Posted by "BJ Freeman (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/OFBIZ-3949?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12912347#action_12912347 ] 

BJ Freeman commented on OFBIZ-3949:
-----------------------------------

since roles are hierarchical,  it  would be best to add the parent Type.
also a note  says what version, rev number the type became available or was removed.
what services, widgets, FTL use this role



> Better RoleType Documentation
> -----------------------------
>
>                 Key: OFBIZ-3949
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3949
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: commonext/setup
>            Reporter: chris snow
>         Attachments: roletype.pdf, roletype.xml
>
>
> This issue is for discussing improving the documentation for RoleType.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.