Introduction
The input page stores configuration information for data collection. Multiple inputs can be created on the Inputs page.
Developers are required to add services in the global config file to create a new Input. If multiple services are provided, a dropdown field will appear on the Inputs page. In contrast, a button will be displayed for a single service.
Properties¶
Property | Type | Description |
---|---|---|
title* | string | - |
description | string | It provides a brief summary of an inputs page. |
subDescription | object | It provides broader description of an inputs page. |
menu | object | This property allows you to enable the custom menu feature. |
table | object | It displays input stanzas in a tabular format. |
groupsMenu | array | This property allows you to enable the multi-level menu feature. |
services* | array | It specifies a list of modular inputs. |
Services Properties¶
Property | Type | Description |
---|---|---|
name* | string | It defines the particular service name. |
title* | string | It shows the title of the service. |
subTitle | string | It shows the subtitle (or additional information) of the service. |
entity* | array | It is a list of fields and their properties. |
groups | array | It is used to divide forms into distinct sections, each comprising relevant fields. |
style | string | By specifying this property in the global configuration file, the forms can either be opened as a new page or in a dialog. Supported values are “page” or “dialog”. The default value is dialog. |
options | object | This property allows you to enable the saveValidator feature. |
hook | object | It is used to add custom behaviour to forms. Visit the Custom Hook page to learn more. |
warning | object | It is used to add the custom warning message for each of the modes of ‘create’, ‘edit’, ‘config’, and ‘clone’. The message is displayed on the form. |
conf | string | TBD |
restHandlerName | string | TBD |
restHandlerModule | string | TBD |
restHandlerClass | string | TBD |
Usage¶
This is how the global configuration looks like without tabs:
"pages": {
"inputs": {
"title": "Inputs",
"description": "Manage your data inputs",
"services": [
{
"name": "example_input_one",
"title": "Example Input",
"entity": []
},
{
"name": "example_input_two",
"title": "Example Input Two",
"entity": []
}
],
"table": {
"actions": [
"edit",
"enable",
"delete",
"clone"
],
"header": [],
"moreInfo": []
}
}
},
Output¶
This is how it looks like in the UI: