Help needed to update an OFBiz Wiki Graffle Diagram

[Ron Wheeler]

On 16/12/2014 10:37 AM, Jacques Le Roux wrote:

>
> Le 16/12/2014 14:21, Ron Wheeler a écrit :
>> I thought that I had seen some UML Use Case fragments but I can not
>> find them again.
>> There are drawings at these locations:
>> https://cwiki.apache.org/confluence/download/attachments/7045155/01MainDiagram.pdf?version=1&modificationDate=1267053493000&api=v2 
>>
>> https://cwiki.apache.org/confluence/download/attachments/7045155/18ArtRefDia.pdf?version=1&modificationDate=1267053493000&api=v2 
>>
>>
>> Do we need them?
>
> Yes, they are part of
> https://cwiki.apache.org/confluence/display/OFBTECH/Framework+Introduction+Videos+and+Diagrams

Are there more on that page than the 2 that I mentioned.

The two that I mentioned could be redone in Open office in an hour or
two if we don't have the sources and they need updating.
The URL is www.ofbiz.org which is not a huge deal.
Who is Underson Consulting?


I seem to recall some Use Cases but can not find them now.

>
> Jacques
>
>> If we do, do we have the sources?
>
> David has them I suppose, maybe even HWM?
>
> Jacques
>
>
>>
>> Ron
>>
>> On 15/12/2014 11:38 PM, Jacques Le Roux wrote:
>>> The graphs at
>>> https://cwiki.apache.org/confluence/display/OFBTECH/Data+Model+Diagrams 
>>> were done using OmniGraffle, that's all what I know. Are you
>>> referring to other places (IIRW other places are older...)
>>>
>>> Jacques
>>>
>>> Le 15/12/2014 20:37, Ron Wheeler a écrit :
>>>> Others may have more definite information about what has been used
>>>> in the past.
>>>>
>>>> I have seen UML(use case) drawings in the wiki that use the same
>>>> (or very similar) graphics that ArgoUML uses.
>>>> ArgoUML is open source
>>>> We are only scratching the surface in our internal use of it so I
>>>> am not an expert modeller but it looks like something that an
>>>> experienced UML modeler should be able to use to get most of the
>>>> diagrams required to support development.
>>>>
>>>> It would be nice to have a product that deals with the issue of
>>>> version control and SCM for models in a way that allowed many
>>>> people to update the models.
>>>> It is probably possible to partition the model into enough chunks
>>>> that people can keep the models up to date without tripping over
>>>> each other.
>>>>
>>>> There are a lot of database models already part of the
>>>> documentation but I am not sure if they are up to date.
>>>> I also do not know what tool was used to make them
>>>> We use MySQL Workbench which is free and produces diagrams that are
>>>> pretty aesthetically pleasing.
>>>>
>>>>
>>>>
>>>> Ron
>>>>
>>>>
>>>>
>>>>
>>>> On 15/12/2014 1:56 PM, Todd Thorner wrote:
>>>>> I'm sold ... for what that's worth. Is there any UML-type facility
>>>>> for
>>>>> the project's future of design & spec-chasing?
>>>>>
>>>>>
>>>>>
>>>>> On 14-12-15 10:41 AM, Ron Wheeler wrote:
>>>>>> On 15/12/2014 1:30 PM, Todd Thorner wrote:
>>>>>>> Yeah, graphs & charts represent special cases.
>>>>>> For the first applications of our ETVL, org charts were a very
>>>>>> useful
>>>>>> output since we were dealing with people in organizations where a
>>>>>> clean
>>>>>> hierarchy is the common way that companies are organized. It was
>>>>>> useful
>>>>>> to have the organizational structure (departments, divisions,
>>>>>> etc) as
>>>>>> well as reporting relationships between people.
>>>>>>
>>>>>> Graphviz is capable of producing very complex charts and has a fair
>>>>>> amount of language features to support customizing the appearance.
>>>>>>
>>>>>> Ron
>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On 14-12-15 09:49 AM, Ron Wheeler wrote:
>>>>>>>> If people don't like the idea of using the Graphviz version
>>>>>>>> that I made,
>>>>>>>> there is a viewer for graffle that runs on the PC. Not sure if
>>>>>>>> any of
>>>>>>>> their other free utilities will output an SVG.
>>>>>>>> Graphviz can outout SVG.
>>>>>>>> I am not sure if it would be easy to use svg as a source.
>>>>>>>>
>>>>>>>> Graphviz offers high level control over placement that usually
>>>>>>>> gives a
>>>>>>>> clean graph without having to manually place nodes.
>>>>>>>>
>>>>>>>> I have just started to use the dynamic javascript version of
>>>>>>>> graphviz in
>>>>>>>> my ETVL tool to output org charts embedded into HTML pages from
>>>>>>>> hierarchical data.
>>>>>>>> Works fine but the org charts are not as nice looking as
>>>>>>>> GetOrgChart's
>>>>>>>> charts and GetOrgChart produces a chart that can be
>>>>>>>> interrogated in the
>>>>>>>> browser to view the detail information stored at each node so I
>>>>>>>> support
>>>>>>>> both ways of generating charts in HTML format.
>>>>>>>>
>>>>>>>> Ron
>>>>>>>>
>>>>>>>> On 15/12/2014 12:04 PM, Todd Thorner wrote:
>>>>>>>>> What happens if you change a .graffle file's extension to
>>>>>>>>> something
>>>>>>>>> else
>>>>>>>>> like SVG or XML?  Any luck?  I know very little about Mac
>>>>>>>>> lock-ins, but
>>>>>>>>> if you can get a text-based file to display (e.g. if .graffle
>>>>>>>>> is .xml
>>>>>>>>> underneath) you might be able to edit the text.
>>>>>>>>>
>>>>>>>>> You could also try taking a screenshot and then editing that by
>>>>>>>>> overlaying the newer links on top of the old image. Quality might
>>>>>>>>> suffer.
>>>>>>>>>
>>>>>>>>> Perhaps committers could consider SVG as a forward-thinking
>>>>>>>>> standard
>>>>>>>>> format for the project's graphical source files
>>>>>>>>> (production-ready files
>>>>>>>>> can be exported as whatever).  My preferred tool is Inkscape
>>>>>>>>> (Windows/Mac/Linux).
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On 14-12-15 06:33 AM, Ron Wheeler wrote:
>>>>>>>>>> Can we move them to open source products such as  Open Office or
>>>>>>>>>> ArgoUML
>>>>>>>>>> or Freeplane?
>>>>>>>>>> These run on all platforms and are all free.
>>>>>>>>>>
>>>>>>>>>> Ron
>>>>>>>>>>
>>>>>>>>>> On 15/12/2014 7:30 AM, Sharan-F wrote:
>>>>>>>>>>> Hi All
>>>>>>>>>>>
>>>>>>>>>>> Does anyone in the community have access to Graffle on a Mac
>>>>>>>>>>> who is
>>>>>>>>>>> willing
>>>>>>>>>>> to help us update one of our wiki diagrams?
>>>>>>>>>>>
>>>>>>>>>>> The diagram that needs to be updated is called
>>>>>>>>>>> OFBizComponentDependencies.graffle (see link below)
>>>>>>>>>>>
>>>>>>>>>>> https://cwiki.apache.org/confluence/pages/viewpageattachments.action?pageId=7766065&metadataLink=true 
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> <https://cwiki.apache.org/confluence/pages/viewpageattachments.action?pageId=7766065&metadataLink=true>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> It forms part of the page around Component Set and Component
>>>>>>>>>>> Set
>>>>>>>>>>> Dependencies page that we want keep up to date.
>>>>>>>>>>>
>>>>>>>>>>> https://cwiki.apache.org/confluence/display/OFBIZ/Component+and+Component+Set+Dependencies 
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> We need to update some links so please respond if you can help.
>>>>>>>>>>>
>>>>>>>>>>> Thanks
>>>>>>>>>>> Sharan
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> --
>>>>>>>>>>> View this message in context:
>>>>>>>>>>> http://ofbiz.135035.n4.nabble.com/Help-needed-to-update-an-OFBiz-Wiki-Graffle-Diagram-tp4659615.html 
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>>>>>>>>>>
>>>>>>
>>>>
>>>>
>>>
>>
>>
>

--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: [phone], ext 102

[pierre.gaudin]

Hi Ron
On 16/12/2014 15:14, Ron Wheeler wrote:
> Looks very nice. The blue shading is a bit too much when the images
> are posted on the wiki - I did find one in my searching and it was
> hard to read the entity name since the black did not have enough
> contrast with the blue.
Thanks.
You can change the background color for each entity.
>
> http://ufo.labs.libre-entreprise.org/UFO/screenshots.html does not
> show all of the UML drawings that one would like to have.
> Use case, Sequence, Activity are not shown.
Sorry, i didn't notice that you also need use case, sequence... UFO is
only for Entity.

Pierre

>
> It looks really good as an ER tool.
> Does anyone know which one was used to make the ER diagrams in the Wiki?
>
> Ron
>
> On 16/12/2014 3:24 AM, pierre.gaudin wrote:
>> Hi all,
>>
>> There is a tool : UFO (UML for OFBIz) that have been developed to
>> make UML diagrams from OFBiz XML entity definition :
>> http://ufo.labs.libre-entreprise.org/UFO/index.html
>> http://www.neogia.org/wiki/index.php/U.F.O.
>>
>> We use it for a long time and it works well. It's on GPL licence but
>> may be it can be set to Apache licence.
>>
>> Pierre
>> On 16/12/2014 05:38, Jacques Le Roux wrote:
>>> The graphs at
>>> https://cwiki.apache.org/confluence/display/OFBTECH/Data+Model+Diagrams 
>>> were done using OmniGraffle, that's all what I know. Are you
>>> referring to other places (IIRW other places are older...)
>>>
>>> Jacques
>>>
>>> Le 15/12/2014 20:37, Ron Wheeler a écrit :
>>>> Others may have more definite information about what has been used
>>>> in the past.
>>>>
>>>> I have seen UML(use case) drawings in the wiki that use the same
>>>> (or very similar) graphics that ArgoUML uses.
>>>> ArgoUML is open source
>>>> We are only scratching the surface in our internal use of it so I
>>>> am not an expert modeller but it looks like something that an
>>>> experienced UML modeler should be able to use to get most of the
>>>> diagrams required to support development.
>>>>
>>>> It would be nice to have a product that deals with the issue of
>>>> version control and SCM for models in a way that allowed many
>>>> people to update the models.
>>>> It is probably possible to partition the model into enough chunks
>>>> that people can keep the models up to date without tripping over
>>>> each other.
>>>>
>>>> There are a lot of database models already part of the
>>>> documentation but I am not sure if they are up to date.
>>>> I also do not know what tool was used to make them
>>>> We use MySQL Workbench which is free and produces diagrams that are
>>>> pretty aesthetically pleasing.
>>>>
>>>>
>>>>
>>>> Ron
>>>>
>>>>
>>>>
>>>>
>>>> On 15/12/2014 1:56 PM, Todd Thorner wrote:
>>>>> I'm sold ... for what that's worth. Is there any UML-type facility
>>>>> for
>>>>> the project's future of design & spec-chasing?
>>>>>
>>>>>
>>>>>
>>>>> On 14-12-15 10:41 AM, Ron Wheeler wrote:
>>>>>> On 15/12/2014 1:30 PM, Todd Thorner wrote:
>>>>>>> Yeah, graphs & charts represent special cases.
>>>>>> For the first applications of our ETVL, org charts were a very
>>>>>> useful
>>>>>> output since we were dealing with people in organizations where a
>>>>>> clean
>>>>>> hierarchy is the common way that companies are organized. It was
>>>>>> useful
>>>>>> to have the organizational structure (departments, divisions,
>>>>>> etc) as
>>>>>> well as reporting relationships between people.
>>>>>>
>>>>>> Graphviz is capable of producing very complex charts and has a fair
>>>>>> amount of language features to support customizing the appearance.
>>>>>>
>>>>>> Ron
>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On 14-12-15 09:49 AM, Ron Wheeler wrote:
>>>>>>>> If people don't like the idea of using the Graphviz version
>>>>>>>> that I made,
>>>>>>>> there is a viewer for graffle that runs on the PC. Not sure if
>>>>>>>> any of
>>>>>>>> their other free utilities will output an SVG.
>>>>>>>> Graphviz can outout SVG.
>>>>>>>> I am not sure if it would be easy to use svg as a source.
>>>>>>>>
>>>>>>>> Graphviz offers high level control over placement that usually
>>>>>>>> gives a
>>>>>>>> clean graph without having to manually place nodes.
>>>>>>>>
>>>>>>>> I have just started to use the dynamic javascript version of
>>>>>>>> graphviz in
>>>>>>>> my ETVL tool to output org charts embedded into HTML pages from
>>>>>>>> hierarchical data.
>>>>>>>> Works fine but the org charts are not as nice looking as
>>>>>>>> GetOrgChart's
>>>>>>>> charts and GetOrgChart produces a chart that can be
>>>>>>>> interrogated in the
>>>>>>>> browser to view the detail information stored at each node so I
>>>>>>>> support
>>>>>>>> both ways of generating charts in HTML format.
>>>>>>>>
>>>>>>>> Ron
>>>>>>>>
>>>>>>>> On 15/12/2014 12:04 PM, Todd Thorner wrote:
>>>>>>>>> What happens if you change a .graffle file's extension to
>>>>>>>>> something
>>>>>>>>> else
>>>>>>>>> like SVG or XML?  Any luck?  I know very little about Mac
>>>>>>>>> lock-ins, but
>>>>>>>>> if you can get a text-based file to display (e.g. if .graffle
>>>>>>>>> is .xml
>>>>>>>>> underneath) you might be able to edit the text.
>>>>>>>>>
>>>>>>>>> You could also try taking a screenshot and then editing that by
>>>>>>>>> overlaying the newer links on top of the old image. Quality might
>>>>>>>>> suffer.
>>>>>>>>>
>>>>>>>>> Perhaps committers could consider SVG as a forward-thinking
>>>>>>>>> standard
>>>>>>>>> format for the project's graphical source files
>>>>>>>>> (production-ready files
>>>>>>>>> can be exported as whatever).  My preferred tool is Inkscape
>>>>>>>>> (Windows/Mac/Linux).
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On 14-12-15 06:33 AM, Ron Wheeler wrote:
>>>>>>>>>> Can we move them to open source products such as  Open Office or
>>>>>>>>>> ArgoUML
>>>>>>>>>> or Freeplane?
>>>>>>>>>> These run on all platforms and are all free.
>>>>>>>>>>
>>>>>>>>>> Ron
>>>>>>>>>>
>>>>>>>>>> On 15/12/2014 7:30 AM, Sharan-F wrote:
>>>>>>>>>>> Hi All
>>>>>>>>>>>
>>>>>>>>>>> Does anyone in the community have access to Graffle on a Mac
>>>>>>>>>>> who is
>>>>>>>>>>> willing
>>>>>>>>>>> to help us update one of our wiki diagrams?
>>>>>>>>>>>
>>>>>>>>>>> The diagram that needs to be updated is called
>>>>>>>>>>> OFBizComponentDependencies.graffle (see link below)
>>>>>>>>>>>
>>>>>>>>>>> https://cwiki.apache.org/confluence/pages/viewpageattachments.action?pageId=7766065&metadataLink=true 
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> <https://cwiki.apache.org/confluence/pages/viewpageattachments.action?pageId=7766065&metadataLink=true>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> It forms part of the page around Component Set and Component
>>>>>>>>>>> Set
>>>>>>>>>>> Dependencies page that we want keep up to date.
>>>>>>>>>>>
>>>>>>>>>>> https://cwiki.apache.org/confluence/display/OFBIZ/Component+and+Component+Set+Dependencies 
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> We need to update some links so please respond if you can help.
>>>>>>>>>>>
>>>>>>>>>>> Thanks
>>>>>>>>>>> Sharan
>>>>>>>>>>> --
>>>>>>>>>>> View this message in context:
>>>>>>>>>>> http://ofbiz.135035.n4.nabble.com/Help-needed-to-update-an-OFBiz-Wiki-Graffle-Diagram-tp4659615.html 
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>

--
Pierre Gaudin
Consultant Fonctionnel Apache-OFBiz, ERP en logiciel Libre

Société Néréide
3b Les isles
37270 Veretz
http://www.nereide.fr
Tel : [phone]
Mob : [phone]

Membre d'OFBiz-France
http://www.ofbiz-fr.org

[Sharan-F]

HI Ron

My understanding from Jacques is that the changes needed are detailed in the comments at the bottom of the page:

1) Order has a  dependency on Marketing
2) Party doesn’t depend on marketing

After the changes I think it would be good to add the comments around these two changes to the main page as part of the general information.

Thanks
Sharan

[Ron Wheeler]

These comments appear to indicate circular dependencies, if I am reading the comments correctly.

It appears that ContactListParty is in the "wrong" package and should be part of the Party module.

Jacopo's comment

"import org.ofbiz.marketing.tracking.TrackingCodeEvents;

used at line 428 of class CheckOutEvents"

describes a circular dependency between order and marketing.
 
I have documented the comments as I understand them and tried to indicate that these are minor coding dependencies rather than major functional design characteristics.

We may want to consider whether complete disclosure of the detailed technical underpinnings helps or hinders the conceptual understanding of the architecture.
Adding the circular dependencies has an impact on the node placement;
When I tried to add the classes that caused the circular dependencies, it made the drawing too messy so I removed the labels on the arrows and just made the arrows grey.

1) Are the colors of the module names meaningful in any way? Do modules shown in the same color have any implied relationship or should I make each module a different color - we can use any of  the named HTML colors?

2) Is there any value in showing a relationship between the 3 main clusters of modules? I doubt if it is helpful but perhaps there are other opinions.

3) Is there any value in specifying the special purpose modules by name? There is lots of room and "specialpurpose" is a bit vague.

4) Would using capital letters for the groups Extended, Framework and Base Applications be more pleasing?



Ron

On 17/12/2014 2:54 AM, Sharan-F wrote:

HI Ron

My understanding from Jacques is that the changes needed are detailed in the
comments at the bottom of the page:

1)	Order has a  dependency on Marketing 
2)	Party doesn’t depend on marketing

After the changes I think it would be good to add the comments around these
two changes to the main page as part of the general information.

Thanks
Sharan




--
View this message in context: http://ofbiz.135035.n4.nabble.com/Help-needed-to-update-an-OFBiz-Wiki-Graffle-Diagram-tp4659615p4659681.html
Sent from the OFBiz - User mailing list archive at Nabble.com.