How do I document a Lookout design?

[NetRanger]

I've used Lookout on a couple of projects. The problem is maintenance -- I have to relearn all the connections between the objects in order to fix or enhance a system. Is there a product that will read Lookout source and produce UML or some other design document / diagram(s)? Lord help my company if I get hit by a truck and someone else has to wade through all the links to figure it all out!

[Chad E]

Hi NetRanger,

The best way to document Lookout is to use descriptive names for all of your objects. For example, instead of using "modbus2" use "West Engine Monitor" and instead of "Pot1" use "Engine RPM".

The rest can be found by using the "Edit Connections", "Edit Data Member Configuration", and "Properties".

Regards,

Chad Evans

[NetRanger]

I appreciate the input, Chad, but although I use good C++ style long object names, hunting through connections is still a pain. Connections are only traceable "forward", so to speak. I can't find dependancies, unless I open the source in an editor and do a "find all". It works, but I think that is a clunky way to do it.

The source code looks like it could be interpreted by a diagraming tool, if the tool were programmed to recognize all the parameter fields for each type of object.

I can't image that all Lookout users, especially those using it on large systems, only use the descriptive names to document their Lookout systems. There has got to be a better way.

[Carl_Finley]

NetRanger,
I can appreciate your situation. I too am the only Lookout developer in my company. What I do is firs of all, like Chad said, is use good alias'. Also good organization is alot of help. All of my objects are organized in folders within the process, this really helps navigation. Once a project is finished I will go to each driver and go to "edit data member configuration" and export the database. This will give you a nicely formatted excel spreadsheet that can be printed and/or manipulated. It will show each configured point and all associated parameters. It has been a great tool for me. I also create similar pointlists for each PLC on the project. The connection browser is also a decent way to find connections associated with objects alt
hough it is a little cumbersome to navigate an interperet. I hope this helps, like I said it has been a great tool for me.