ROAM Quickstart Guide
Reaching the tool
Click here to go to the login page for the ROAM Tool.
Alternatively, the tool can be found by going to the EFPF portal. After logging in, the user has to navigate to “Smart Factory Solutions” in the dashboard to the left. (See the red arrow in the images). The ROAM Tool portal page can be found in the newly collapsed list below Smart Factory Solutions in the dashboard, or in the list toward the end of the screen under the header “Factory Connectivity and Smart Factory Solutions”. Once the user is on the ROAM Tool page, the tool can be opened by clicking on the “Try Now” button at the top.
Using the tool
Upon opening the tool, the user is met with two expandable lists containing so-called recipes and workflows.
In the recipe list, the user can find premade “base” recipes. These serve as recipe templates, in which the user can choose parameters to tailor them to the user’s liking. It is possible to create customized recipes by clicking on the “+” icon in the top left, or by clicking the middle “copy and edit” icon for a base recipe. Furthermore, recipe information can be found by clicking on the arrow next to the recipe name and collapsing the detail row.
When creating a recipe, the user can choose a name, description, tags for filtering purposes, and usernames to share the recipe with. The user also needs to choose a base recipe type and the relevant parameters. Each parameter contains an “i” icon that shows the parameter description when hovering over it. When the recipe type has been chosen, the user can also click on an “i” button to show recipe information and a more elaborate recipe description.
There is also a workflow list that works just like the recipe list, but there are more buttons. The extra buttons allow for “starting” and “stopping” the workflow, retrieving the last workflow output, and, if the workflow contains a recipe with cache functionality, resetting the workflow cache.
Users can also define workflows. Workflows are a sequence of recipes that each transform the data coming in through MQTT. This data is then parsed as json and passed to the first recipe in the workflow. Once the workflow is done with running all intermediate recipes, it will publish the output via MQTT again.
While creating a workflow, the user can choose a name, description, tags, and usernames to give access. Additionally, the user has to choose input, output, and error topics, and a vhost, for the MQTT functionality.
Lastly, the user needs to choose the workflow recipes. These can be chosen from the already customized recipe. Recipes can also be defined while creating a workflow.
For more information, visit the user guide