Generate CodeMRI® Blueprint Diagrams

CodeMRI® Sys Admin Training Videos:

Generate CodeMRI® Blureprint Diagrams

To see the blueprint diagram, you can run the job, job run produce_API_diagrams. This is an example of a diagram that gets created when you run produce API diagrams. As you can see, each box here represents a component that was defined and all the arrows between the box represent relationships. One thing to note, and it's very interesting, is that if you don't define relationships, or any relationship that isn't defined will show up when it's discovered and it will be colored differently from the relationships that were defined.

So for instance, if you're working with a legacy codebase and there's no architecture diagrams, there's no architecture documentation, A wonderful way to discover the architecture is to define the components and then run this diagram and it'll show you all the relationships. As you can see, this one looks fairly busy and there's a way to zoom in on that.

We can run another command. We can generate blueprints on a selected subset of components. We do that with the same command as we produce the API diagram. We do job run produce_API_diagrams, but we give it the parameter of --component, -subset, and we give it a list of components that we would like included in the subset, and then we give it –name, and we name the entire.

Another way to do this instead of providing a list of components, we can create a file inside the file. We can list the name of every component we would like included, and then we can execute the job by typing in job run produce API diagrams, --component -subset -file and provide a path to the file and again, --name.

And a name for the subset of the. Here we can look at the output on a test run from another system, and this is a subset of the data from the previous picture. This one is much more understandable when we zero in on just a couple of components, and so for systems that are very complicated that have a lot of relationships, this is perhaps an easy way. To piece by piece, try to understand the system