web stats
Documenting Interfaces - Mirth Community

Go Back   Mirth Community > Mirth Connect > General Discussion

Reply
 
Thread Tools Display Modes
  #1  
Old 01-07-2015, 10:44 AM
kirbykn2's Avatar
kirbykn2 kirbykn2 is offline
Mirth Guru
 
Join Date: Sep 2014
Location: Michigan
Posts: 577
kirbykn2 is on a distinguished road
Post Documenting Interfaces

I am looking for the best way to document Mirth interfaces. I know Mirth has the ability to generate PDF's from the channels. Has anyone used this for either all or part of their interface documentation?

Any suggestions for the tools or processes you use to document interfaces is greatly appreciated.

Thanks,

Kirby
Reply With Quote
  #2  
Old 01-07-2015, 10:46 AM
kirbykn2's Avatar
kirbykn2 kirbykn2 is offline
Mirth Guru
 
Join Date: Sep 2014
Location: Michigan
Posts: 577
kirbykn2 is on a distinguished road
Default

Also, how do you document changes to your interfaces. Is this something that can also be documented within the Mirth channel?

Last edited by kirbykn2; 01-07-2015 at 10:58 AM.
Reply With Quote
  #3  
Old 01-07-2015, 12:58 PM
clarky clarky is offline
Mirth Newb
 
Join Date: Nov 2013
Location: Iowa
Posts: 10
clarky is on a distinguished road
Send a message via Skype™ to clarky
Default

I've been doing a couple of things. One thing I have done to make it easier to visually see what is going on in the channels for me and other co-workers; I created a http listener channel that returns a web page. The page is updated on each request with the current state of channels I have running. It takes the start and endpoints of each channel and then adds that data to the Google Charting API. The api then produces a sankey Diagram of my channels (eg diagram)

For Detailed information I use onenote. I would like to use another tool, but haven't found anything that I really like.
Reply With Quote
  #4  
Old 01-30-2015, 05:00 AM
Rodger Glenn Rodger Glenn is offline
Mirth Newb
 
Join Date: Dec 2011
Location: Deltona, fl
Posts: 15
Rodger Glenn is on a distinguished road
Default Documenting Interfaces

We backup our channels to a shared drive and I have written a style sheet to make them human readable in explorer.
Reply With Quote
  #5  
Old 02-05-2015, 07:18 AM
kirbykn2's Avatar
kirbykn2 kirbykn2 is offline
Mirth Guru
 
Join Date: Sep 2014
Location: Michigan
Posts: 577
kirbykn2 is on a distinguished road
Default

Thanks for the replies,

I haven't used a Sankey Diagram, this is an interesting concept.

Roger,

Are you able to give a visual representation of the message flow with your style sheet?
__________________
Kirby

Mirth Certified|Epic Bridges Certified|Cloverleaf Level 2 Certified

Appliance Version 3.11.2
Mirth Connect Version 3.6.1
Java Version 1.6.0_45-b06
Java (64 bit) Version 1.6.0_45-b06
Java 7 (64 bit) Version 1.7.0_151-b15
Java 8 (64 bit) Version 1.8.0_121-b13
PostgreSQL Version 9.6.3

Last edited by kirbykn2; 02-05-2015 at 08:32 AM.
Reply With Quote
  #6  
Old 02-17-2015, 07:04 AM
Rodger Glenn Rodger Glenn is offline
Mirth Newb
 
Join Date: Dec 2011
Location: Deltona, fl
Posts: 15
Rodger Glenn is on a distinguished road
Default

Kirby,
No, but at the time that was not our goal. Our first goal was to create support documentation.
Reply With Quote
  #7  
Old 02-06-2015, 02:10 PM
Dewayne.Mellen Dewayne.Mellen is offline
Mirth Newb
 
Join Date: Nov 2014
Posts: 8
Dewayne.Mellen is on a distinguished road
Default

Could you share your style sheet?
Reply With Quote
  #8  
Old 02-17-2015, 07:16 AM
Rodger Glenn Rodger Glenn is offline
Mirth Newb
 
Join Date: Dec 2011
Location: Deltona, fl
Posts: 15
Rodger Glenn is on a distinguished road
Default

DeWayne,
The one I have right now is for support purposes we put all of our contact information in the description. We backup our channels to a shared drive I wrote a power shell script to add this to the top of the xml filr "<?xml version="1.0"?> <?xml-stylesheet type="text/xsl" href="Mirth.xsl"?> " so it can be read by the stylesheet and then you can open them in Internet explorer to view.
Reply With Quote
Reply

Tags
channel, document, documentation, interface engine

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump


All times are GMT -8. The time now is 07:18 AM.


Powered by vBulletin® Version 3.8.7
Copyright ©2000 - 2019, vBulletin Solutions, Inc.
Mirth Corporation