Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
odoodo authored Dec 24, 2024
1 parent 3d24f7d commit c9af023
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
<p align="center"><img src="https://github.com/user-attachments/assets/7d9cabf1-b4d2-4e32-8b40-3a579f398b72"></p>
<b>Mirth Migrator</b> automates the transfer of <a href="https://www.nextgen.com/solutions/interoperability/mirth-integration-engine/mirth-connect-downloads" target="_blank">Mirth Connect Enterprise Service Bus</a> channels and code templates from one instance to another. It further allows to check the validity of channels & code templates. <br/>
<b>Mirth Migrator</b> is a web-based tool that automates the transfer of <a href="https://www.nextgen.com/solutions/interoperability/mirth-integration-engine/mirth-connect-downloads" target="_blank">Mirth Connect Enterprise Service Bus</a> channels and code templates between Mirth environments. It further allows to check the validity of channels & code templates. <br/>
<br/>
This tool works with the Open Source as well as the commercial version of Mirth Connect.
<h2>Features</h2>

<h2>Key Features</h2>
<ul>
<li><b>Code Templates and Channel Migration</b><br/>Code templates, channels, and even entire Channel Groups or Code Template Libraries can be migrated between Mirth instances with a single click. Code templates of directly or indirectly referenced functions can be automatically migrated with the channels.<br/><br/>
If a component already exists at the destination instance, conflict handling will be activated. The component to be migrated will be compared with the corresponding component of the target system, and the user can choose to skip its migration or overwrite the one on the target side.</li>
<li><b>Consistency check</b><br/>Channel and function inconsistencies are directly indicated. Mirth Migrator shows if a channel or function uses other functions but the referenced function is not defined anywhere. It further indicates if a function is used by a channel but the code template library containing this function is not referenced by a channel. These checkings are important as inconsistencies often do not occur directly at channel deployment but only when the business logic hits an errourneous spot.</li>
<li><b>Meta Data and Source Code Viewing</b><br/>When a component is selected, important metadata and the source code are displayed.</li>
<li><b>Documentation</b><br/>Upon clicking on a component, the relevant documentation is displayed. In the case of functions, this may include their descriptions, parameter definitions, and expected return values. In the case of channels, this may include a description and a change history. Multiple functions in one code template will be displayed as separate items.</li>
<li><b>Compare</b><br/>If a component selected at one instance already exists at the other instance, it will be highlighted, and a compare button will appear. The source code and metadata for components can be compared in two ways: side-by-side or inline.</li>
<li><b>Function Dependency Checking</b><br/>For each function, it is indicated which other functions it uses, as well as the channels and/or functions through which it is used.</li>
<li><b>Channel Dependency Checking</b><br/>For each channel, either directly or indirectly referenced functions are shown. It is further indicated which code template libraries it references and if these references are correct. Non-needed as well as missing library references are highlighted</li>
<li><b>Web-Based Application</b><br/>Mirth Migrator is a fully web-based application provided via a Mirth channel. There is no need for a separate user management system as it utilises the user pool of the Mirth installation, which runs the channel.</li>
<li><b>Transfer Channels and Code Templates</b><br/>Migrates channels and associated code templates between environments with ease, maintaining consistency across systems. </li>
<li><b>Function-Dependency Analysis</b><br/>Detects and maps dependencies between JavaScript functions in code templates and their usage in channels or other functions.
Identifies which channels and functions rely on specific functions, as well as where functions are used. </li>
<li><b>Conflict Handling</b><br/>Resolves version conflicts during migration, ensuring compatibility between the source and target environments. </li>
<li><b>Inconsistency Detection</b><br/>Analyzes channels and code templates to uncover inconsistencies or missing dependencies that could cause errors post-migration. </li>
<li><b>Environment Comparison</b><br/>Allows for a detailed comparison of channels and functions between environments, helping maintain synchronization. </li>
<li><b>Transparency in Function Usage</b><br/>Provides clear insights into which JavaScript functions are utilized by specific channels or other functions, aiding debugging and development.</li>
</ul>

<h2>Use Cases</h2>
<ul>
<li><b>Environment Synchronization</b><br/>Maintain consistent code and channel configurations across development, testing, and production environments. </li>
<li><b>Conflict Resolution</b><br/>Identify and handle mismatched versions of functions or channels during migrations. </li>
<li><b>Code Audit and Optimization</b><br/>Detect unused functions or redundant code within the environment for optimization.<br/>Also detect missing function or function references in channels & functions, which will result in runtime errors.</li>
<li><b>Dependency Mapping</b><br/>Gain a better understanding of how functions and channels interact, crucial for large or complex Mirth Connect installations. </li>
</ul>

<h2>Screenshots</h2>
<kbd><img src="https://github.com/odoodo/Mirth-Migrator/assets/61003874/01fb4697-c3b1-4927-83b5-3880f2cad292" width="160"></kbd>
<kbd><img src="https://github.com/odoodo/Mirth-Migrator/assets/61003874/582d4991-04b5-4132-805d-48aee2267c80" width="160"></kbd>
Expand Down

0 comments on commit c9af023

Please sign in to comment.