This is the first article in the user manual for Calabash GUI.
This article covers the GUI home page and gives you an overview of other articles about various facets of the GUI. The prerequisite of this article is Calabash Architecture. Make sure you have read that.
The front page of Calabash GUI at https://calabash.datacanals.com looks like this:
The first section of this page is an introduction slider. It has a brief guide about Calabash and the steps of using it. You may close it by clicking on “Hide Intro.”
The second section is for creating the first type of object, called “data systems.” A data system is the owner of all other things. You need at least one data system. However, you must first log in to create anything.
All other object types you can use within a data system are shown on the top menu. These are
- infrastructure objects
- readers
- parsers
- lookups
- data pipelines
- writers
The article on Calabash Architecture explains their roles in a data lake. The order of these menu items roughly corresponds to the order of your design work.
Sign Up, Login, and User Profile
Please read this article about sign-up, login and user profile.
Create Data System
Once we have logged in to Calabash, the Home page looks like this:
We have no data system yet. Click on “Create Data System” button to create one. The create data system form is shown below:
The data system name is required. You should enter a unique name without special characters, as the data system name may be used by code generator as a namespace, depending on circumstance. The platform is always GCP for now. And you may add some brief explanation about this data system. Click on Save then we will be brought back to the home page again. Now the new data system is on the list.
You can delete, edit, and sort data systems (if you have more on the list).
Some words of caution about deleting a data system. When you delete a data system, all objects owned by it will also be deleted. Hours of design work could be lost. Calabash will warn you about this fact. Since this operation is irreversible, delete with care.
Create Infrastructure Objects
Please read this article about creating infrastructure objects.
Create Readers
Please read this article about creating readers.
Create Parsers
Please read this article about creating parsers.
Create Lookups
Please read this article about creating lookups
Create Data Pipelines
Please read this article about creating data pipelines.
Create Writers
Please read this article about creating writers.