Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: site
    • Labels:
      None
    • Sprint:
      Bug Crush Event - 21/2/2015

      Description

      This issue is for discussing improving the documentation for RoleType.

      1. roletype.xml
        10 kB
        chris snow
      2. roletype.pdf
        33 kB
        chris snow

        Activity

        chris snow created issue -
        Hide
        chris snow added a comment -

        Example RoleType documentation.

        Show
        chris snow added a comment - Example RoleType documentation.
        chris snow made changes -
        Field Original Value New Value
        Attachment roletype.xml [ 12454995 ]
        Attachment roletype.pdf [ 12454996 ]
        Hide
        chris snow added a comment -

        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

        Show
        chris snow added a comment - 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
        Hide
        BJ Freeman added a comment -

        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.

        Show
        BJ Freeman added a comment - 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.
        Hide
        BJ Freeman added a comment -

        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

        Show
        BJ Freeman added a comment - 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
        Hide
        chris snow added a comment -

        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

        Show
        chris snow added a comment - 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
        Hide
        chris snow added a comment -

        Amended to show ofbiz version for RoleType and RoleType hierarchy.

        Show
        chris snow added a comment - Amended to show ofbiz version for RoleType and RoleType hierarchy.
        chris snow made changes -
        Attachment roletype.pdf [ 12455056 ]
        Attachment roletype.xml [ 12455057 ]
        Hide
        chris snow added a comment -

        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:

         
        <PartyRole partyId="admin" roleTypeId="BUYER"/>
        <PartyRole partyId="admin" roleTypeId="MANAGER"/>
        <PartyRole partyId="admin" roleTypeId="ORDER_CLERK"/>
        <PartyRole partyId="admin" roleTypeId="SHIPMENT_CLERK"/>
        

        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

        Show
        chris snow added a comment - 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: <PartyRole partyId= "admin" roleTypeId= "BUYER" /> <PartyRole partyId= "admin" roleTypeId= "MANAGER" /> <PartyRole partyId= "admin" roleTypeId= "ORDER_CLERK" /> <PartyRole partyId= "admin" roleTypeId= "SHIPMENT_CLERK" /> 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
        chris snow made changes -
        Attachment roletype.pdf [ 12455056 ]
        chris snow made changes -
        Attachment roletype.pdf [ 12454996 ]
        chris snow made changes -
        Attachment roletype.xml [ 12455057 ]
        chris snow made changes -
        Attachment roletype.xml [ 12454995 ]
        chris snow made changes -
        Attachment roletype.xml [ 12455066 ]
        Attachment roletype.pdf [ 12455067 ]
        Sharan Foga made changes -
        Sprint Bug Crush Event - 21/2/2015 [ 91 ]
        Sharan Foga made changes -
        Rank Ranked higher
        Sharan Foga made changes -
        Rank Ranked higher
        Sharan Foga made changes -
        Rank Ranked higher
        Pierre Smits made changes -
        Component/s site [ 12311567 ]
        Component/s commonext/setup [ 12313162 ]
        Hide
        Pierre Smits added a comment -

        Moving it to site, as it seems to be a documentation issue.

        Show
        Pierre Smits added a comment - Moving it to site, as it seems to be a documentation issue.
        Hide
        Ron Wheeler added a comment -

        Where?
        This relates to a question that I asked in the mailing list about "best practices" for roles and relationships.
        Some of the things that I lump in under "best practices" could be described as "only practices" since it appears that some roles are used by the system without further configuration by the system admin.(see MANAGER and SHIPMENT_CLERK above)

        Assigning these roles without being aware of how the system will interpret them can cause security problems or unexpected behaviour.

        Show
        Ron Wheeler added a comment - Where? This relates to a question that I asked in the mailing list about "best practices" for roles and relationships. Some of the things that I lump in under "best practices" could be described as "only practices" since it appears that some roles are used by the system without further configuration by the system admin.(see MANAGER and SHIPMENT_CLERK above) Assigning these roles without being aware of how the system will interpret them can cause security problems or unexpected behaviour.
        Hide
        Pierre Smits added a comment -

        The 'only' best practice is only the first best practice.

        There have many discussions in the past about how roles should be interpreted. Some are used as a classification, some are used to enhance permissions. OFBiz allows both.

        Show
        Pierre Smits added a comment - The 'only' best practice is only the first best practice. There have many discussions in the past about how roles should be interpreted. Some are used as a classification, some are used to enhance permissions. OFBiz allows both.

          People

          • Assignee:
            Unassigned
            Reporter:
            chris snow
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:

              Development

                Agile