Corda 5 CorDapp Flow Management Tool

This user guide provides step-by-step instructions on using the Corda 5 flow management tool. This article will help you learn how to connect the running corDapp, make flow calls, configure flow queries, and retrieve results.

Prerequisites

• Install and run Python and Flask framework. link.

• Prepare your local Corda 5 environment. (By default, the Flow Management Tool is looking to connect to https://localhost:8888/api/v1/swagger#/ with Login: Admin and Password: Admin.)

• Clong the Flow Management Tool repository. FlowManagementUI: main

Set Up

1. Assuming your local Corda 5 environment is populated and the swagger endpoint is at: https://localhost:8888/api/v1/swagger#/

2. Navigate to where you downloaded the Corda 5 Flow Management Tool

3. To run the framework

   • Navigate to the file name using cd command.

   • use the python app.py command to run it.

   • Later on, click on the IP Address which will open the Interface:

The Flow Management Tool should be automatically connected with the CorDapp running locally from your CSDE. You can test the connection by click on the dropdown list at the Flow Initiator section. You should be able to see the vNodes of your started CorDapp from CSDE.

Set Up With Docker

1- Open up Command Prompt

2- Navigate to the application folder using the CD commands

3- Ensure that Docker application is open and build the image using the following command: docker build -t your-image-name .

Make sure to include the dot at the end of the command

the your-image-name at the end of the command can be whatever you like but make sure to use the same name in the next step

4- Run the docker image using the following command: docker run --rm -it --expose 8888 -p 5000:5000 your-image-name

5- You can access the website by using https://localhost:5000 or https://127.0.0.1:5000

Using the Flow Management Tool

Selecting the Flow Initiator

As the first step of using the Flow Management Tool, you would need to select the Flow Initiator. The Flow Initiator indicates which vNode will be triggering the flow. If you wish to have Alice to run a transaction to Bob, select the X500Name of Alice. The selected vNode’s shortHash (Corda 5 Network participant identifier) will also be shown below the dropdown list to signify your selection.

Function 1: To Make a Flow Call

1. Click on "Flow Call" tab in the application.
2. Paste the your JSON format request body into the request input box.
3. Click Post button to trigger the call.

Function 2: To Configure Flow Query

1. Click on the “Flow Query” tab.
2. Choose whether to query a single flow or all flows at the selected Flow Initiator.
3. If you choose to query all of the flows, select “Query All Flows“ then click “Get“.

4. If you choose to query a single flow, select “Query Single Flow“, please add the ClientID in specified filed. 5. Click on “Get” to retrieve the result.

If you have any suggestions or questions, feel free to give us your feedback through Github for a better experience in the future!

Conclusion

In summary, our project introduces a specialized flow management layer on top of Swagger for Corda developers. We understand the challenges developers face in testing Corda applications due to the complexity of commands, our solution focuses on simplifying the process.

Our all-in-one flow management system provides developers with a unified platform, streamlining development and enhancing efficiency. A key feature allows developers to run flows directly from an externally developed website and monitor their status in real-time, offering a user-friendly and practical solution for Corda developers. Overall, our project aims to make Corda development more accessible and tailored to the specific needs of flow management.