LAE

Note: This was originally posted by an inactive account. Content was preserved by moving under an admin account.

Originally posted by: eparoak

I'm a consultant who often needs to provide our clients with user friendly documentation about our models, assumptions, and processes used.

Hence I was looking for the method to print different expansions of the graphs, details of the nodes and any information saved under the "Documentation" tabs.

There doesn't seem to be an easy way to do this other than screen grabs, print screens or just copy paste texts.

Is there a feature to do this or has someone worked out an easy method, or can we suggest it be added as an enhancement.

Our team is looking to use Lavastorm in a number of areas and this was an immediate ommission we need to cover.

Jim

Note: This was originally posted by an inactive account. Content was preserved by moving under an admin account.

Originally posted by: stonysmith

There is a way to produce a level of documentation using BRE.

It starts with "Name your Nodes" and "Fill in the Documentation Tab"

It's not "required", but it is a good rule: you should always change the NAME on these six types of nodes: Input, Filter, Join, Xref, Lookup, Output

By changing at least the name of the nodes, you can later trace thru the graph and figure out what you were trying to do.

On each node, (and on composites) there is the option to enter Developer / Functional / and API documentation.

If you enter all of that, then the Tools/Generate Documentation/Graph Reports menu option will bundle all the available doc up and produce an HTML document of it all.

The doc is a bit crude, but it may help you on your way.

====
If you click on Tools/Preferences/Advanced, there is an option "Extract Records on Execution"

If you have that option selected before you run the graph, then when you Generate a Graph Report, it will include a pre-set number of records from each output into the HTML that is produced.. sort of a data dictionary WITH the rest of the documentation.

Note: This was originally posted by an inactive account. Content was preserved by moving under an admin account.

Originally posted by: eparoak

Thx very much I'll see how it goes. No wonder I didn't see how to do it the 1st time!

Note: This was originally posted by an inactive account. Content was preserved by moving under an admin account.

Originally posted by: dwong80

This is function available in LAE v3.x? If so, where is the generate graph function? I found the settings under "Preferences --> Documentation Generator"

Note: This was originally posted by an inactive account. Content was preserved by moving under an admin account.

Originally posted by: timonk

Good Day,

Nodes in 3.X have Documentation and Node API tabs, yes.
Text placed in the FUNCTIONAL section of the Documentation tab becomes hover-text which shows up when you mouse over the node.
Text in the API section of the Doc tab is what actually shows up on the Node API tab, FUNCTIONAl text also shows there as well.

You can then go to the FILE--> Generate Doc menu and it will produce an HTML file which describes the nodes in your graph, broken up by "Functional Doc", "Developer Doc", and "API Doc". Plus an "Extended Documentation" section that shows a text-style description of each complete node with current status, properties, and binary identification.

I dropped a couple nodes and produced a file just to make a quick example, see attached.

Regards
Timon Koufopoulos
MDA Support.
Attachments:
MY DOC TEST GRAPH.zip