OFBiz
  1. OFBiz
  2. OFBIZ-305

New "description" attribute for entitymodel fields to help keep comments

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Duplicate
    • Affects Version/s: Trunk
    • Fix Version/s: None
    • Component/s: framework
    • Labels:
      None

      Description

      Copy of http://jira.undersunconsulting.com/browse/OFBIZ-582 from Leon Torres.

      =========================================================

      Please put in this small change to the entitymodel xsd which will add a "description" attribute to entity fields, to help describe the fields. It'll be nice to keep comments about the data model right there with the definition and will also allow later on for them to be displayed by an entity model viewer such as those in webtools.

      All Comments Work Log Change History Sort Order:
      Comment by David E. Jones [18/Dec/05 11:26 PM] [ Permlink ]
      Rather than using an attribute a sub-element for this is probably better, especially if the description ever gets a bit longer. This is also more consistent with the descrption under the entity and view-entity elements. Now it can be put under just about everything.

      This patch still does not include code changes to put these values in the corresponding objects during the parsing, so the code for the following elements needs to be changed (and this issue should perhaps stay open until they are):

      field
      relation
      index
      member-entity
      alias-all
      alias
      view-link

      The XSD file updates are in SVN rev 6365.

      Comment by Chris Howe [07/Jan/06 05:02 AM] [ Permlink ]
      Can this issue be closed?

      Comment by Si Chen [09/Jan/06 04:08 PM] [ Permlink ]
      Actually somebody needs to write some code for getting this field into ModelField/ModelEntity/etc. etc. Want to take a shot at it?

      Comment by Marco Risaliti [14/Sep/06 02:12 AM] [ Permlink ]
      Can I move it ?

      Thanks
      Marco

      Comment by Marco Risaliti [14/Sep/06 03:02 AM] [ Permlink ]
      This patch seems to be not applied so probably no-one need it.
      Can I close it ?

      Thanks
      Marco

      1. entitymodel_field_description.patch
        0.5 kB
        Marco Risaliti
      2. Description_Model.patch
        10 kB
        Chris Howe

        Issue Links

          Activity

          Marco Risaliti created issue -
          Marco Risaliti made changes -
          Field Original Value New Value
          Attachment entitymodel_field_description.patch [ 12340876 ]
          Hide
          Marco Risaliti added a comment -

          Hi Leon Torres,

          I have seen that the attached pacth is too old and it cannot be review to understand what they do.
          So if you want that this issue will progress you have to attach a new patch otherwise it will be closed (incomplete).

          Thanks
          Marco

          Show
          Marco Risaliti added a comment - Hi Leon Torres, I have seen that the attached pacth is too old and it cannot be review to understand what they do. So if you want that this issue will progress you have to attach a new patch otherwise it will be closed (incomplete). Thanks Marco
          Hide
          Jacques Le Roux added a comment -

          Marco,

          This patch was already applied by David (see comment above : rev 6365). But some changes need always to be done in parsing. So please don't close this issue.

          Show
          Jacques Le Roux added a comment - Marco, This patch was already applied by David (see comment above : rev 6365). But some changes need always to be done in parsing. So please don't close this issue.
          Jacopo Cappellato made changes -
          Description Please put in this small change to the entitymodel xsd which will add a "description" attribute to entity fields, to help describe the fields. It'll be nice to keep comments about the data model right there with the definition and will also allow later on for them to be displayed by an entity model viewer such as those in webtools.
           
           

           All Comments Work Log Change History Sort Order:
          Comment by David E. Jones [18/Dec/05 11:26 PM] [ Permlink ]
          Rather than using an attribute a sub-element for this is probably better, especially if the description ever gets a bit longer. This is also more consistent with the descrption under the entity and view-entity elements. Now it can be put under just about everything.

          This patch still does not include code changes to put these values in the corresponding objects during the parsing, so the code for the following elements needs to be changed (and this issue should perhaps stay open until they are):

          field
          relation
          index
          member-entity
          alias-all
          alias
          view-link

          The XSD file updates are in SVN rev 6365.

          Comment by Chris Howe [07/Jan/06 05:02 AM] [ Permlink ]
          Can this issue be closed?

          Comment by Si Chen [09/Jan/06 04:08 PM] [ Permlink ]
          Actually somebody needs to write some code for getting this field into ModelField/ModelEntity/etc. etc. Want to take a shot at it?

          Comment by Marco Risaliti [14/Sep/06 02:12 AM] [ Permlink ]
          Can I move it ?

          Thanks
          Marco

          Comment by Marco Risaliti [14/Sep/06 03:02 AM] [ Permlink ]
          This patch seems to be not applied so probably no-one need it.
          Can I close it ?

          Thanks
          Marco
          Copy of http://jira.undersunconsulting.com/browse/OFBIZ-582 from Leon Torres.

          =========================================================


          Please put in this small change to the entitymodel xsd which will add a "description" attribute to entity fields, to help describe the fields. It'll be nice to keep comments about the data model right there with the definition and will also allow later on for them to be displayed by an entity model viewer such as those in webtools.
           
           

           All Comments Work Log Change History Sort Order:
          Comment by David E. Jones [18/Dec/05 11:26 PM] [ Permlink ]
          Rather than using an attribute a sub-element for this is probably better, especially if the description ever gets a bit longer. This is also more consistent with the descrption under the entity and view-entity elements. Now it can be put under just about everything.

          This patch still does not include code changes to put these values in the corresponding objects during the parsing, so the code for the following elements needs to be changed (and this issue should perhaps stay open until they are):

          field
          relation
          index
          member-entity
          alias-all
          alias
          view-link

          The XSD file updates are in SVN rev 6365.

          Comment by Chris Howe [07/Jan/06 05:02 AM] [ Permlink ]
          Can this issue be closed?

          Comment by Si Chen [09/Jan/06 04:08 PM] [ Permlink ]
          Actually somebody needs to write some code for getting this field into ModelField/ModelEntity/etc. etc. Want to take a shot at it?

          Comment by Marco Risaliti [14/Sep/06 02:12 AM] [ Permlink ]
          Can I move it ?

          Thanks
          Marco

          Comment by Marco Risaliti [14/Sep/06 03:02 AM] [ Permlink ]
          This patch seems to be not applied so probably no-one need it.
          Can I close it ?

          Thanks
          Marco
          Hide
          Chris Howe added a comment -

          Description_Model.patch

          Adds the description to the models for
          field
          index
          view-entity
          alias-all
          alias
          complex-alias
          complex-alias-field
          relation

          I'm not really positive how to test this patch. I followed the pattern for ModelEntity

          Show
          Chris Howe added a comment - Description_Model.patch Adds the description to the models for field index view-entity alias-all alias complex-alias complex-alias-field relation I'm not really positive how to test this patch. I followed the pattern for ModelEntity
          Chris Howe made changes -
          Attachment Description_Model.patch [ 12347373 ]
          Adam Heath made changes -
          Assignee Adam Heath [ doogie ]
          Jacopo Cappellato made changes -
          Link This issue relates to OFBIZ-1389 [ OFBIZ-1389 ]
          Hide
          Jacopo Cappellato added a comment -

          Can we close this issue now that OFBIZ-1389 has been resolved?

          Show
          Jacopo Cappellato added a comment - Can we close this issue now that OFBIZ-1389 has been resolved?
          Hide
          Jacopo Cappellato added a comment -
          Show
          Jacopo Cappellato added a comment - See OFBIZ-1389
          Jacopo Cappellato made changes -
          Resolution Duplicate [ 3 ]
          Status Open [ 1 ] Closed [ 6 ]
          Gavin made changes -
          Workflow jira [ 12383750 ] OFbiz Workflow [ 12503923 ]

            People

            • Assignee:
              Adam Heath
              Reporter:
              Marco Risaliti
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development