Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend CALM CLI to Support Visualizing Business Flows #477

Open
LeighFinegold opened this issue Oct 15, 2024 · 0 comments
Open

Extend CALM CLI to Support Visualizing Business Flows #477

LeighFinegold opened this issue Oct 15, 2024 · 0 comments

Comments

@LeighFinegold
Copy link
Member

LeighFinegold commented Oct 15, 2024

Feature Request:

Currently, CALM provides a command-line interface (CLI) tool that allows users to visualize nodes and relationships in an architectural specification. While this is valuable for understanding the technical architecture, it does not visualize business flows that traverse these components. Something that is now possible in CALM via #426.

Propose modifying the existing CLI to support the visualisation of business flows. This enhancement would allow users to input a separate flow specification file, enabling them to see how business processes interact with nodes and relationships in the architecture.

Potential solutions

  1. Provide a visualize option where only the flow document is provided as input argument
    calm visualize -f flow.json

    In this solution, a flow definition has links back to the calm document which contains the references node/relationships.

  2. Enhance the existing command to take a flow id which you want to visualise
    calm visualize -i calm.json -f "flow-001"

    This solution implies that calm.json has direct knowledge of all flows that are linked to it i.e. core.json would be updated to contain a flows array.

  3. Specify both the calm.json alongside the flow.json document you want to visualise
    calm visualise -i calm.json -f flow.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant