Documenting Interfaces

[Ryan Spires]

Just curious what others may be doing in the realm of documenting their interfaces that might be multi threaded (more than a simple inbound and outbound), cross site, cross platformed, and perhaps multi applications (Secure Courier for example)   As we continue to pull in more uniquely configured interfaces, I am finding it more difficult to provide adequate support documentation that provides enough detail to support without simply going directly to the site configurations and such…

Anyone have any uniquely creative ideas that they might be willing to share?

I am trying to keep in mind that an interface (in how I would define it)  typically is end to end (originating thread to final destination thread) instead of just a single thread and may include multiple hops before leaving the engine.  Also trying to keep in mind that we may be sending through to other applications that we support as well.

I have some ideas on how to improve what we are currently doing, but would love to brainstorm with anyone willing to participate in some discussion.

Thanks,

Ryan Spires

Topic

[Troy Morton]

Hi Ryan,

I know that some shops out there have written software that will traverse NetConfig and “generate” a route for a particular outbound thread from the source to the end.

I’m not sure if anyone would be willing to share, though, because such code is pretty valuable in distinguishing someone as a high-level Cloverleaf developer.

If you examine the NetConfigs closely, you’ll see that they are just really giant Tcl KEYED lists.

[James Cobane]

Troy/Ryan,

We have several procs that we developed that pull different information from the NetConfig.  I’ve attached a document that briefly decribes them.  Let me know if you are interested in any of them.

Jim Cobane

Henry Ford Health

[Kevin Crist]

Jim,

These tclprocs look very interesting and informing. I wouldnt mind taking a look at them, i think we could do some neat stuff with that.

thanks.

[James Cobane]

I’ve posted a .tar file that contains all of the scripts.  Modify as you see fit for your own needs.

Enjoy!

Jim Cobane

Henry Ford Health

[Author]

Replies