Announcement

Collapse
No announcement yet.

Documenting Interfaces

Collapse
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

  • 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
    Best,

    Kirby

    Mirth Certified|Epic Bridges Certified|Cloverleaf Level 2 Certified

    Appliance Version 3.11.4
    Mirth Connect Version 3.8.0
    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_181-b13
    PostgreSQL Version 9.6.8

  • #2
    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, 10:58 AM.
    Best,

    Kirby

    Mirth Certified|Epic Bridges Certified|Cloverleaf Level 2 Certified

    Appliance Version 3.11.4
    Mirth Connect Version 3.8.0
    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_181-b13
    PostgreSQL Version 9.6.8

    Comment


    • #3
      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.
      Jesse Clark, NCP, CHTS-TS, Mirth Certified
      Director of Development
      Shared IT, Inc.

      Comment


      • #4
        Documenting Interfaces

        We backup our channels to a shared drive and I have written a style sheet to make them human readable in explorer.

        Comment


        • #5
          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?
          Last edited by kirbykn2; 02-05-2015, 08:32 AM.
          Best,

          Kirby

          Mirth Certified|Epic Bridges Certified|Cloverleaf Level 2 Certified

          Appliance Version 3.11.4
          Mirth Connect Version 3.8.0
          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_181-b13
          PostgreSQL Version 9.6.8

          Comment


          • #6
            Could you share your style sheet?

            Comment


            • #7
              Kirby,
              No, but at the time that was not our goal. Our first goal was to create support documentation.

              Comment


              • #8
                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.

                Comment


                • #9
                  <?xml version="1.0" encoding="UTF-8"?>
                  <xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
                  <xsl:template match="/">
                  <html>
                  <img src="http://../integration/Mirth/SiteAssets/SitePages/Home/Mirthlogo.png" align="middle" />

                  <body class="default">
                  <STYLE type="text/css">.default {font-family: Times New Roman;font-size: 9pt; color: #333333;}
                  .header {background-color: #0000FF;font-weight:bold;cursor: hand;}
                  .header2 {background-color: #8181F7;font-weight:bold;}
                  .header3 {background-color: #00ffff; font-weight:bold;}
                  .tablecaption {background-color: #A9D0F5;font-weight:bold;}
                  .tableheader {background-color: rgb(230,230,230);font-weight:bold;font-size: 8pt;}
                  .literal {font-family: Times New Roman:font-size: 8pt;}

                  </STYLE>
                  <!--<h2 class="header2">
                  <xsl:value-of select="/channel/name "/>
                  </h2>-->
                  <p>
                  Filename:
                  <xsl:value-of select="/channel/name "/>
                  <br/>
                  Last Revision Registered:
                  <xsl:value-of select="/channel/lastModified/time "/>
                  <br/>
                  </p>
                  <!-- General connection/channel information
                  -->
                  <table border="0" width="100%" cellspacing="0" cellpadding="0">
                  <caption>
                  <h2 class="tablecaption">Channel Configuration</h2>
                  </caption>
                  <xsl:for-each select="/channel/sourceConnector ">
                  <xsl:sort select="/channel/name"/>
                  <tr class="literal">
                  <td>
                  <form action="">
                  <fieldset>
                  <h2 class="header3">
                  Channel name :
                  <xsl:value-of select="/channel/name "/>
                  </h2>
                  </fieldset>

                  <!-- Channel Description -->

                  <fieldset>
                  <pre><xsl:value-of select="/channel/description "/></pre>
                  </fieldset>

                  </form>
                  </td>
                  </tr>
                  </xsl:for-each>
                  </table>
                  </body>
                  </html>
                  </xsl:template>
                  </xsl:stylesheet>

                  Comment


                  • #10
                    Thanks for sharing the stylsheet. It's been a few years since I've worked with these, but it seems pretty self explanatory.

                    Jesse,

                    Can you share channel? I am curious if there is a way to use your configuration to dynamically display the status of each interface end-point in a web page.
                    Best,

                    Kirby

                    Mirth Certified|Epic Bridges Certified|Cloverleaf Level 2 Certified

                    Appliance Version 3.11.4
                    Mirth Connect Version 3.8.0
                    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_181-b13
                    PostgreSQL Version 9.6.8

                    Comment


                    • #11
                      Documenting Interfaces

                      Put both of these files in the same directory and then rename the mirth.xml to mirth.xsl open the xml file in internet explorer.
                      Attached Files
                      Last edited by Rodger Glenn; 03-25-2015, 06:59 AM. Reason: left a part out.

                      Comment


                      • #12
                        Has anyone been able to make a visual diagram of your message flow by using the channels XML?
                        Best,

                        Kirby

                        Mirth Certified|Epic Bridges Certified|Cloverleaf Level 2 Certified

                        Appliance Version 3.11.4
                        Mirth Connect Version 3.8.0
                        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_181-b13
                        PostgreSQL Version 9.6.8

                        Comment


                        • #13
                          Documentation XSLT

                          Hallo,

                          If anyone can use this, see attachment.

                          This is a XSL creating html-documentation, based on the full Export of mirth 3.3.

                          It creates an index.html with a table of all enabled channels with name and description, with links to detail html-pages. These (still in development, we're starting with Mirth) list technical details and have a graphical representation (not perfect) of the 1:n source:destinations principle.
                          Attached Files

                          Comment


                          • #14
                            Online Documentation tool 4 Mirth Connect

                            We are working on an online tool to create mirth docs. It is in beta right now so give it a try.

                            Https://Documentor.Email

                            Regards Matt
                            X Connections
                            https://documentor.email
                            https://www.x-connections.com

                            Comment


                            • #15
                              for our situation, we use Git to handle movement of interfaces from dev to live. So, for simple interfaces, the git logs are suitable documentation, and offer an easy way to roll back.

                              for more complex interfaces, I'll usually block diagram the work. Mostly I want other people to just be able to look at the interface documentation and be able to debug a problem. I really don't want to have to teach them how to read the documentation. obviously... this works for SMALL outfits like where I work, perhaps not suitable for everyone.

                              the product I use is yED, and it's really quite nice!
                              Attached Files

                              Comment

                              Working...
                              X