[jira] [Commented] (OFBIZ-9128) Document current possiblities of the EntityAutoEngine

["Paul Foxworthy (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/OFBIZ-9128?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15700533#comment-15700533 ] 

Paul Foxworthy commented on OFBIZ-9128:
---------------------------------------

Variation 3 in the list of auto-engine capabilities is a special case of number 4. It might make sense to treat 2 part keys differently from 3-or=more part keys in the code, but documentation can leave out case 3 altogether.

I suggest the XSD should have a brief reference to the Service Engine Guide, and should not duplicate documentation elsewhere.

> Document current possiblities of the EntityAutoEngine
> -----------------------------------------------------
>
>                 Key: OFBIZ-9128
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-9128
>             Project: OFBiz
>          Issue Type: Sub-task
>          Components: Confluence, framework
>    Affects Versions: Trunk
>            Reporter: Jacques Le Roux
>            Priority: Minor
>             Fix For: Upcoming Release
>
>
> As explained [~paul_foxworthy] [in this comment|https://issues.apache.org/jira/browse/OFBIZ-9117?focusedCommentId=15672946&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-15672946]
> {quote}
> I don't expect entity-auto to handle every possible situation. I'd suggest we keep it simple and 80-20 rather than fiddle with it forever.
> There's an error message if you try to push it too hard which lists what it can do:
> "1. a single OUT pk for primary auto-sequencing, " +
> "2. a single INOUT pk for primary auto-sequencing with optional override, " +
> "3. a 2-part pk with one part IN (existing primary pk) and one part OUT (the secondary pk to sub-sequence), " +
> "4. a N-part pk with N-1 part IN and one party OUT only (missing pk is a sub-sequence mainly for entity assoc), " +
> "5. all pk fields are IN for a manually specified primary key");
> So it can deliver one new id in an out parameter, but not more than one. I can live with that. For more complex situations, we can write a service rather than use entity auto.
> {quote}
> I suggest we document it in services.xsd and the [Service Engine Guide|https://cwiki.apache.org/confluence/display/OFBIZ/Service+Engine+Guide], explaining what the possiblities are based on the message above. BTW I had a look at services.xsd and it's not yet documented enough.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)