Creating a DataPortal
Create a new DataPortal by choosing the icon in the side navigation bar.
You will be presented with an overview page. We urge you to read through the description shown, and also download the sample Excel template files that are available (on the right hand side of the screen).
Begin with one of the Excel templates provided, then modify it to reflect the data model you are creating.
Your Excel file can include sheets of a few different types:
Master (required): This is the first sheet that is processed by Composable and acts as a link to all other container sheets that will ultimately be shown to the end user. Sheet name:
"Master". The Name field given as a value here will serve as the root database name.
Container: These specify what input fields are listed out in each web page the user sees, as well as any controlling logic of how they are saved (Type) and displayed (ControlType). Think of these sheets as tables in your data model, with each input field name representing a column in a SQL table. Most of your DataPortal sheets will be containers. Sheet name: anything not already used for another purpose (not Master/ReadMe/CSS).
Category: These specify a single picklist for the end user, such as Gender or the State you live in. They can either be an individual sheet or have multiple in the
Categoriessheet. In this sheet, each column represents its own category to simplify the Excel structure if you have a lot of categories in your data model. Sheet name: Either
Categoriesor anything not already used for another purpose.
Settings: These allow for customization of some DataPortal actions. Named like
ReadMe: This sheet is not processed or displayed to the end user of forms, it is a place to store notes and comments on the model. Sheet name:
CSS: An optional sheet for the user to enter custom CSS rules to style the forms page with any colors, margins or other custom style behavior. Sheet name:
Container Sheet Basics
Each sheet in the Excel workbook represents a container which is a similar object to a table. Column headings in a sheet define the control setting, with rows representing values. The following column headers are typically found on each of the Excel sheets:
- Name (required): A whitespace-free name for the field. Think of this as the name you would give this field in a database.
- DisplayName: A human-friendly label that will be displayed above the input box for the field on the user interface. This can contain rich text written in Markdown.
- Description: A longer description that can be displayed in a tooltip on the user interface to more fully explain the field.
- Type (required): The name of the data type of the given field, such as integer or string, that the data will be stored as in the database.
- ControlType (required): The type of field interface that the user will input their data into, also known as a form control. Examples are a textbox (Text) or calendar date selection (Date), or a checkbox.
- Required: Indicates whether the field is required.
- For each ControlType, other columns can be added which specify settings. These are in "5.6 Container Fields", which provide additional features or restrictions on a field.
When referencing another container/sheet, the syntax is
When selecting multiple values, such as the Columns in a Table, put square brackets around the column names to select multple values.
[Form.<ContainerName>.<Column1>, Form.<ContainerName>.<Column2>, Form.<ContainerName>.<Column3>].
Building a DataPortal
To build the DataPortal, simply save the Excel template, and drag and drop it into Composable. Done.
As Composable reads through and parses the Excel workbook, Composable is building the entire database layer, ORM layer as well as a full web-based CRUD (Create, Read, Update, Receive) interface.
Once the DataPortal, a blue button will appear that allows you to access the web-based interface.