🔥Quick Start Guide

New user quick start guide on how to use basic functionalities of SmartFlow.

SmartFlow Basics

SmartFlow provides you with several main capabilities:

1. Creation of business logic (SmartFlow) using the no-code NodeRed editor, either from scratch or with pre-defined templates

2. Registering new Worker Network Solutions on the EnergyWebX parachain (EWX)

3. Control of lifecycle created SmartFlows as well as registered Solutions

To understand the basic process of what happens when creating and registering a SmartFlow, check out the Worker Network Solution deployment flow.

Subscription

Before you can start using SmartFlow, you will need a subscription.

To subscribe:

1. Go to https://launchpad.energyweb.org/ and login using your existing credentials if you are an Energy Web Member, or the social login options (Google and Github).

2. Ensure you are in the SaaS environment of Launchpad by checking the toggle button on the top right. You will easily recognize the SaaS environment by its white theme.
3. On the left hand side menu, click on SmartFlow and then "Subscription"
4. Select the subscription relevant to you and proceed to the payment. The "EW Member" plan is only available for enterprises that are Energy Web members. Once your payment is completed, you subscription is active.

Creation & Deployment of new solution

Creation of New SmartFlow

1. Assuming that you have an active subscription, you are ready to create a new SmartFlow. Click on SmartFlow in the left hand side menu, and click "Create new". Select "SmartFlow" in the pop un that appears and click "Continue".

   

   The pop-up will appear when clicking "Create new" under "SmartFlow"
2. On the templates choice screen, choose the template that is relevant to you or select "Create your own" and click "Select Template". In the following examples, we are using the EV Green Reward - EXAMPLE.

   
3. The next screen will give you more information on the template you selected. If it fits your needs, click "✔️ Use this template"

4. Give your SmartFlow a name and description and click "Save"

   

Your new SmartFlow will appear under the menu SmartFlow > "Manage" as a draft. You can edit it using the NodeRed editor by clicking on the edit button on the top right of the flow Edit button A new tab will open with NodeRed editor, where you can make adjustments to your SmartFlow file:

If you make any changes, remember to save them using the "Save" button on top right of the editor

5. Go back to the SmartFlow Manage page, click on the three dots and choose "Publish to IPFS". You can now use your flow within the New Worker Network Solution Registration. The flow status will change to "Published"

Registration of new Worker Network Solution

1. Create a New Worker Network Solution by clicking "Create New" under SmartFlow and then choosing "Worker Network" and "Continue" in the pop-up.
2. Populate the Solution Information details. You will be asked to select if your Worker Network solution is subject to production deployment or not. Choosing "No" will mean that your solution will only be deployed on the Playground SmartFlow Worker Node Network only. Choosing "Yes" will trigger a review process allowing your solution to be added to a public SmartFlow pool. For the full process, please see the following page.

   

   Once you have filled in all the fields, press "Continue".

3. In the solution workload tab, in a Work Logic choose the SmartFlow you have created earlier or the one that is relevant to your current solution. Press "Continue".

   
4. Determine your solution expiration block and click "Register".

   
5. The Solution registration consists of two steps:

   1. Solution registration on-chain

   2. Adding to a solution group.

   After your solution is registered you will be automatically redirected to the SmartFlow Manage page and you will see your solution with the "In-Progress" status. Within a few minutes you should see two notifications on the top right informing you that your solution was added to a group successfully and created successfully. The solution will then appear with the "Paused" status.
6. Activate your solution by clicking on the three dots on the Worker Network Solution card, and then selecting "Activate".

7. After a few minutes, your solution will be active:

Validate your work

If you want to verify that your actions were correctly recorded on the blockchain: Go to polkadot.js interface choose workerNodePallet & the solutions method as shown below. On the top right, disable "include option" and click on the "+" symbol. You can then search for your solution using the namespace that you have chosen at registration.

You should be able to query and find the solution you registered. The "Work Logic" field indicates the IPFS CID where your SmartFlow logic is stored, while the "Status" reflects the current state of the solution.