Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Modules are the sub sections of the screen where the input fields are placed. User can add rows and columns in module based on their respective designs. User can drag and drop the required fields inside module layout to create the desired form. The module configuration provides a list of features to include in an entity. One module is mapped to one table in the database. Module configuration require user to specify the database table name, table keys and sequences of the associated table. It also provides an option for user to write manual SQL queries to retrieve values from the database using some alternate logic.
AppDesigner supports 3 types of modules:
1-1 Module
1-Many Module
Reusing Module
(1-Many) module displays and manages data fields for multiple records in the database. It shows data in tabular form. The One to Many (1-Many) module is based on grid and card layout design and allow users to handle large num1-1 module displays and manages data for one record in the database. It is based on row and column layout where you can simply add rows and columns as per your required design. Simply drag the 1-1 Module icon to the desired Tab to create a 1-1 Module.
The 1-1 Module configuration provides a list of property settings (1-5) as shown below:
- This icon is used to open "Module Configuration" property window. 1-1 Module configuration property window provides a list of settings which can be helpful in specific needs or special purposes. All 1-1 Module configuration settings along with their usage are listed in table below:
Module Item
Default value
Mandatory
Description
Module ID
N/A
Y
Module ID is the unique ID and it is generated by system automatically.
Module Name
1-1 Module
Y
The appropriate name for a module.
Table Name
N/A
Y
The table associated with that module.
Template Code
Responsive2016
Y
Default to same as template Code used for an Entity.
Theme Code
Responsive2016
Y
Default to same as theme Code used for an Entity.
Show List Layout
GRID
Y
Show Grid Layout / Card Layout for the search result.
Module Key
N/A
Y
This is set the field to be used as the Key to the Module.
Prefix
N/A
This is used to configure prefix that will be added to the beginning of the Key when automatically generated.
Postfix
N/A
This is used to configure suffix that will be added to the end of the Key when automatically generated.
KeyLen
N/A
Y
Key Len is to set size of key.
Sequence
N/A
Y
Database Sequence to be used for key generation.
SQL Show List
N/A
This is used to set the manual SQL Command used to query data to display in Module in Tabular Format (Only used in 1- Many Modules).
SQL Work Queue
N/A
This is used to set the manual SQL Command to query data to display in Search Results.
SQL Select Row
N/A
This is used to write the manual SQL Command to be used to query data in 1-1 Module.
SQL Duplicate Function
N/A
-
View Mode Flag
N
Make your module in View/Read Mode only.
Paging Flag
N
Enables paging for search result.
Ordering Flag
N
Enables sorting in the headed of data grid.
Multiple table Flag
N
-
- This Icon is used to drag and drop modules to rows and columns in Multi Column Tab Form layout.
- This Icon is used to set the Column Layout which determines how many columns the module has. It has 3 options to choose from - 1 Column, 2 Column and 3 Column. User can select any options based on the layout requirement. User must click on 'Accept' button after choosing a desired option.
- This Icon is used to delete a Module from your Smart Form Layout.
- This Icon is used to add column or row inside your Module Layout. First Icon add Column in your module and second icon is used to add row. User can add multiple rows and columns inside module Layout on basis of smart form requirements.
Entity on ONEWEB platform refers to the group of business data and transactions involved in your business processes. For e.g. Customer, Order, Product, TaxInvoice etc. The first step to create any smart form on ONEWEB platform is to create and define the Entities in your business. You have to carefully define the scope of each business entity before starting your smart form configurations. Some of the Key points about an "Entity" that user should know are:
A Smart Form on ONEWEB platform can consist of a single Entity or a group of Entities linked together depending on your Smart Form complexity.
App Designer is a Smart Form builder on ONEWEB to create entities and is available under DEV ZONE on top left corner of ONEWEB MENU bar.
User can also search for any existing Entity on App Designer by clicking on search icon.
On Top left of Entity Menu
Step 1 Click on "Create New Entity", a popup message will show to confirm if you want to create a new Entity.
Step 2 Click "OK" to begin.
Entity configuration consist a list of several configuration settings which can be accessed by using an Entity Menu
Note: Entity Menu can be available anytime at the top right corner on screen once any entity is open.
All Icons on the Entity Menu are listed below with reference to its significance.
Entity Item
Default value
Mandatory
Description
Entity ID
N/A
Y
Entity ID is unique and its generated by system automatically.
Entity name
Entity Name
Y
User can edit default value -
' Entity Name ' to any user defined value as per business needs.
Template code
Responsive2016
Y
Active Entity Template Code
Theme code
Responsive2016
Y
Active Entity Theme Code
System code
EAF_XXX
Y
System Code for application Schema
Version
v001
Y
Version control of an Entity
Default search
N
Entity to Search by default when open Search Screen
Default insert
N
Entity to Save by default when open Entity Screen
Require workflow
N
-
Workflow workqueue
N
-
Tab Condition
N
Whether the entity uses tab conditioning
Hide Tab
N
To hide the child tab
View mode
N
To open entity in view mode only
Load tab
N
-
Not to auto-create user
N
-
History flag
N
-
Copy all list
N
-
Show radio
N
Show radio button on the Search screen
Show Checkbox
N
Show check box on the Search screen
Not to show multi-result
N
-
Not to RSDefSearch
N
-
hisBuddhistFlag
N
-
ImageViewer
N
To add imageViewer app to the Entity
The 'Reusing module' allows user to reuse modules existing in other entities and copy to your smart form. It saves the work for the designer when they have to create very similar modules. The Module Configuration of a Reusing Module is same as that of 1-1 or 1-Many Module configuration depending on the type of module copied. Only the way of creation is different.
The Checkbox is an input field used to allow selection of one or more choice from multiple choices. Once user drags a field of type Checkbox onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Checkbox Configuration Settings are described below:
The Hidden field is a field used to store hidden values on page like id. Once user drags a field of type Hidden onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Hidden Configuration Settings are described below:
The Label is a field used to display text. Once user drags a field of type Label onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Label Configuration Settings are described below:
The Radio is an input field used to allow selection of a specific choice from multiple choices. Once user drags a field of type Radio onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Radio Configuration Settings are described below:
- This icon is used to edit the Entity Configurations. The most common property under Entity configuration is the "Entity Name" property which specifies the name of your entity. It is always a best practice to choose the Entity name that can uniquely describe and identify your entity and its scope. The Entity Configuration window provides a list of additional properties which can be helpful in specific needs or special purposes. All Entity properties along with their usage are listed in the table below:
- This icon is used to configure the Action Flow, to integrate with Microflow
- This icon is used to save an entity. It's always a best practice to save entity after every configuration.
- This icon is used to open the search preview of your entity screen. You can preview your entity in search mode once you have provided the table inside your module configuration and are working on partial configuration.
- This icon is used to open a Create/ Insert preview of your entity. You can preview your entity in create/insert mode once you have provided the table inside your module configuration and are working on partial configuration.
- This icon is used to open the help screen.
- This icon is used to go back to the Application screen.
-This icon is used to open console and check activity logs.
-This icon is used to open the smart data entry screen.
Fields are the different types of input fields that are used inside module layout to enter user inputs. User can drag and drop a list of required fields inside a module to create a desired form. The different types of fields supported by ONEWEB are as follows:
Field Type
Description
Text box
To enter text and numbers.
Label
To show static labels on the screen. It comes with rich text options.
Hidden
To store hidden fields on screen. Mostly used to manipulate the module keys.
Text Area
To enter text of more than 100 characters.
Radio button
To allow selection of a specific choice from multiple choices.
Checkbox
To allow selection of one or more data from multiple choices.
Listbox
To display a list of static data as a dropdown. The values to be shown are set in the field itself.
Dynamic List
To display a list of values dynamically as a dropdown. The data is shown from a table in the database and can be controlled to show values depending on another field in the module.
Popup
To display a list of data from a table in database as a popup window. It also has a text box for searching data based on the key
Calendar
To enter date fields
Suggestion box
This field can suggest data to user in a dropdown based on the data keyed in. Moreover, users can use keyword search in this field
No Object
Special field used to display a custom value on the screen that is not part of the data in the table of the module.
Multi Select
To provide multiple select option.
Upload
To attach and upload files.
Note: Fields can only be dragged and dropped inside your Entity Modules. So, It is important to note that user must first drag the module inside entity and specify the rows and columns, and then only can begin to add fields into entity.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Tabular Type
N
To set the checkbox as a table.
Checkbox Form Values
Value
Y
Value of the radio item
ShowName
Y
Displayed text for the radio item
Seq
N
Sequence of the radio item
Default Check
N
To have the item checked by default
Source tag
This field is used to insert JavaScript at the item level.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Default Value
The default value for this field.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
Show Data
To enter the text to be displayed in the place of this field. User can enable RichText option to add RichText content
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Radio Display Data
Value
Y
Value of the radio item
ShowName
Y
Displayed text for the radio item
Seq
N
Sequence of the radio item
Default Check
N
To have the item checked by default
Source tag
This field is used to insert the JavaScript at the item level.
ColumnCount
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before savingCHECK_EMAIL_FORMAT - require user to input value in email format before saving.
The Text area is an input field used to enter text of more than 100 characters. Once user drags a field of type Text area onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Text area Configuration Settings are described below:
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Row Size
4
The number of rows to be displayed in the text area.
Default Value
The default value for this field.
Display as Rich Text
N
To define whether to enable Rich Text or not.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
The Suggestion is an input field used to suggest data to user in a drop down based on the data keyed in. Moreover, users can use keyword search in this field. Once user drags a field of type Suggestion onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Suggestion Configuration Settings are described below:
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Max Length
Maximum number of characters allowed on this field
Size
Maximum size to be displayed.
Default Value
The default value for this field.
Table Name
Y
To define the table from where the data is retrieved dynamically.
Column Show
Y
To define the column whose value should be displayed in the list.
Condition
To define any condition for retrieving data.
Global ID
To define Global ID of the field.
Dependency Data
Depend Column
To define the column on which the data will depend on.
Sequence
To define the sequence of the column in the condition.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
Condition Tab
N
To define if this field trigger condition tab feature.
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
The List Box is an input field used to display a list of static data as a dropdown. Once user drags a field of type List Box onto the entity, user must click on the edit icon to open the configuration window as shown below.
The List Box Configuration Settings are described below:
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Listbox Form Values
Value
Y
Value of the list item
ShowName
Y
Displayed text for the list item
Seq
N
Sequence of the list item
Default Check
N
To have the item selected by default
Source tag
This field is used to insert JavaScript at the item level.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
Condition Tab
N
To define if this field trigger condition tab feature.
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
The Popup is an input field used to display a list of data from a table in database as a popup window. It also has a text box for searching data based on the key. Once user drags a field of type Popup onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Popup Configuration Settings are described below:
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Popup Display Data
DB Column Name
DB Column
Show Name
Display name on popup window
Seq
Sequence of the fields
Alignment
Alignment of field on popup
Display
Yes
To define field as hidden field or display field.
SQL Command
Y
The SQL Command to retrieve the data to be displayed on popup.
Search Key
The field to be used for the search
Map Column
Y
The column whose value is mapped back to main field if selected
Map Column Display
Y
The column that is displayed as code on the main field
Map Description
Y
The column that is displayed as description on the main field
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Text Size
Size of the Code field.
Max Length
Maximum number of characters allowed on this field
Map Entity
Show Go Button
Description Size
To define size of description field.
SearchLike in Popup
N
To define wildcard search in the popup.
UNClose Flag
N
To define if popup needs to close automatically on selection or not.
SearchIgnoreCase in Popup
N
To define if the search should ignore case.
Search Criteria Entity ID
Global ID
To define Global ID of the field.
Dependency Data
Depend Column
To define the column on which the data will depend on.
Sequence
To define the sequence of the column in the condition.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving. CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
1-Many) module displays and manages data fields for multiple records in the database. It shows data in tabular form. The One to Many (1-Many) module is based on grid and card layout design and allow users to handle large number of items and columns.
The 1-Many Module configuration provides a list of property settings with 2 icons as shown below:
- This icon is used to open "Module Configuration" property window. 1-Many Module configuration property window provides a list of settings which can be helpful in specific needs or special purposes. All 1-Many Module configuration settings along with their usage are listed in table below:
Actions are hooks provided by App Designer to attach a custom JSP, JavaScript or a custom Java class to your entity. App Designer supports 2 Types of Actions Configuration inside your smart form.
Entity Action: Entity Actions cover an entire entity. You can attach Java classes to Entity Action to override the function to save or update an entity. But you cannot attach a JSP file to an Entity Action.
The Entity Action provides 2 icons - to open Action Field Configuration window and to delete an existing Entity action.
Below List specifies all Entity Action Items along with their description.
Module Action: Module Action covers only the corresponding module. You can include a custom JSP into your module using a Module Action. You can also add Java class to override add, update, save functions on the module, or add any JavaScript functions to customize the interaction on the module.
Below List specifies all Module Action Items along with their description.
Text Box onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Text Box Configuration Settings are described below:
The Upload is an input field used to attach and upload files. Once user drags a field of type Upload onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Upload Configuration Settings are described below:
The MultiSelect is an input field used to select multiple values. Once user drags a field of type MultiSelect onto the entity, user must click on the edit icon to open the configuration window as shown below.
The MultiSelect Configuration Settings are described below:
The Calendar is an input field used to enter dates. Once user drags a field of type Calendar onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Calendar Configuration Settings are described below:
The No Object is an input field used to display a custom value on the screen that is not part of the data in the table of the module. It is mostly used to display custom data or data from another table. Once user drags a field of type No Object onto the entity, user must click on the edit icon to open the configuration window as shown below.
The No Object Configuration Settings are described below:
The Dynamic List is an input field used to display a list of values dynamically as a dropdown. Once user drags a field of type Dynamic List onto the entity, user must click on the edit icon to open the configuration window as shown below.
The Dynamic List Configuration Settings are described below:
- This Icon is used to delete a Module from your Smart Form Layout.
An Edit icon allows opening an Action Field Configuration window as shown below:
Similar to an Entity action, Module Action also provide 2 icon's - Icon to open Action Field Configuration window and Icon to delete an existing Module action.
An Edit icon allows opening an Action Field Configuration window as shown below:
Module Item
Default value
Mandatory
Description
Module ID
N/A
Y
Module ID is the unique ID and it is generated by system automatically.
Module Name
1-Many Module
Y
The appropriate name for a module.
Table Name
N/A
Y
The table associated with that module.
Template Code
Responsive2016
Y
Default is set to same as Entity Template. No Edit Required.
Theme Code
Responsive2016
Y
Default is set to same as Entity Theme. No Edit Required.
Show List Layout
GRID
Y
Select GRID Layout or Card layout for the list for 1- Many.
Module Key
N/A
Y
This is set the field to be used as the Key to the Module.
Prefix
N/A
This is used to add to configure Prefix that will be added to the beginning of the key when automatically generated.
Postfix
N/A
Used to configure suffix that will be added to the end of the key when automatically generated.
KeyLen
N/A
Key Len is to set size of key.
Sequence
N/A
Y/N
Database Sequence to be used for key generation.
SQL Show List
N/A
This is used to set the manual SQL Command used to query data to display in Module in Tabular Format (Only used in 1- Many Modules).
SQL Work Queue
N/A
This is used to set the manual SQL Command to query data to display in Search Results. Only for 1-1 Modules
SQL Select Row
N/A
This is used to write the manual SQL Command to be used to query data in 1-1 Module. Only used in 1-1 Module.
SQL Duplicate Function
N/A
-
View Mode Flag
N
Set your module in View/Read Mode only.
Paging Flag
N
Enables paging for 1- Many Module.
Ordering Flag
N
Enabled sorting in the header of data grid.
Multiple table Flag
N
-
Entity Action Item
Mandatory
Description
Module Action ID
Y
System generated can't edit by user.
ENTITY_ID
Y
System generated can't edit by user.
Process Name
Y
Search/Insert/Update
Script File
JavaScript File Action
Class Action
Fully qualified Java Class name
Module Action Item
Mandatory
Description
Module Action ID
Y
System generated can't edit by user.
MODULE_ID
Y
System generated can't edit by user.
Process Name
Y
Search/Insert/Update
JSP/HTML File Path
JSP File Action
Script File
JavaScript File Action
Class Action
Fully qualified Java Class name
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Source Tag
This field is used to insert the Javascript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Max Length
20
Maximum Field length of content to be stored.
Size
20
Maximum Field length to be displayed
Password Flag
N
This is used to display the characters in password format.
Default Value
The default value for this field.
Number Formatter
Help to format fields containing numbers. It contains 3 types to choose from: Integer, currency and Decimal.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Upload Path
The upload file path on server.
Max File Size
256
To define the maximum file size allowed.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen..
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Default Value
The default value for this field.
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Table Name
Y
To define the table from where the data is retrieved dynamically.
Column Show
Y
To define the column whose value should be displayed in the list.
Column Value
Y
To define the column whose value will be used as the value of selected data.
Condition
To define any condition for retrieving data.
Alt Desc
Destination Table
The table to store the multiple values
Parent Key
To define the column which is used for foreign key reference.
MultiSelect List Key
To define the corresponding key column in multi select table.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Max Length
20
Maximum field length of content to be stored.
Size
20
Maximum field length to be displayed
Use Calendar
Y
This is used to define if the calendar icon needs to be displayed or not.
Buddhist Calendar
N
To use Buddhist date.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
SearchCriteria
N
To define if this field is to be used as one of the search criteria in the search screen.
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
Property
Default value
Mandatory
Description
MF ID
System Generated number
Y
MF ID is unique and is generated by system automatically.
Default Value
The default value for this field.
Source Tag
This field is used to insert the JavaScript at the Field level e.g.: readonly, onchange = validateNum(this) etc.
Table Name
Y
To define the table from where the data is retrieved dynamically.
Column Show
Y
To define the column whose value should be displayed in the list.
Column Value
Y
To define the column whose value will be used as the value of selected data.
Condition
To define any condition for retrieving data.
Global ID
To define Global ID of the field.
Dependency Data
Depend Column
To define the column on which the data will depend on.
Sequence
To define the sequence of the column in the condition.
Field_ID
[FIELD_ID]
To define the database field mapped to this field on the smart form.
ShowFieldName
[SHOW_FIELD_NAME]
Y
To define the field label to be displayed on the screen. Clicking on the blue icon will auto generate the field name based on field id
Condition Tab
N
To define if this field trigger condition tab feature.
Search Criteria
N
To define if this field is to be used as one of the search criteria in the search screen..
ShowSearch
N
To define if this field is to be one of the search results (in table)
SearchFromTo
N
To define if the field is to be searched in range in the search criteria.
SearchPreLike
N
To define if this field should allow wildcard search e.g. (%XXX)
SearchLike
N
To define if this field to allow wildcard search e.g. (XXX%)
SearchIgnoreCase
N
To define if this field is to allow search by ignoring case.
JoinSearchTable
N/A
Usually required when JOIN SQL is used to produce the search screen. Join with another table to show results
SearchFieldGroup
0
This setting is used to configure the position of the field in the search criteria screen horizontally (row).
SearchCriteriaSeq
0
To configure the position of field in the search criteria screen vertically (column).
ShowSearchSeq
0
To configure the position of the field in the search results.
Alignment
left
To set Text Alignment. It provides 3 options to choose from: right /left /center.
OnlyGuiFlag
N
To configure the field as a UI field. This field is not persisted into the database.
ViewFlag
N
Y- To view field in read/view mode in Edit screen.
KeepHistory
N
To configure the field values to have history information persisted into database.
FilterFlag
N
Used in 1-Many module to filter the records based on value of the field.
Authen
N
Enabling it, calls an ONEWEB authorization engine (IAM)
MergeFlag
N
To merge this field to the next column as well. Usually used to display a field across two columns
Validate Code
CHECK_NULL
Y - to make Validation check.
CHECK_NULL- will check for null in the field before saving.
CHECK_INTEGER - will check for integer value before saving.
CHECK_DECIMAL - will check for decimal value before saving.
CHECK_EMAIL_FORMAT - require user to input value in email format before saving.
AppDesigner allows cloning of business entities by providing "Clone Entity" feature under the Entity Menu. Cloning feature helps users to avoid creating similar smart forms again and again and instead using Cloning feature to replicate them with a click of button. User can create as many replicas as needed, and later customize them to meet business requirements. Clone Entity Feature can be accessed under Entity Menu as shown below
Go to top left Entity Menu > Entity > Clone Entity
Select an existing Entity under select "Select Existing Entity"
Specify the name of Clone Entity
Click on Clone
Note: New name shouldn't be same as any Existing Entity
The system will show the success message with a link to open the new cloned entity.
Tabs inside Entities provide user with an ability to present a lot of data or gather several inputs from a user without designing a large and complex form. Tab Navigation helps to separate content into sections and access using a flat navigation structure. As a result, each tab can be viewed separate from each other, and not in context of each other. This design is also very helpful when the content for each tab has different structure. Tabs can easily be dragged and dropped inside your entity and you may add as many tabs as needed. Tabs are created based on your DB relationship structure. App Designer also provides tab condition feature to conditionally Enable/Disable or Show/Hide the tabs inside your smart Form.
Tab condition can be set based on the values of a designated field. User can set Tab condition as 'Y' to enable this feature and can control the tabs on their smart forms based on data in the fields.
For example: Let's say one department has 3 service types - 'Hardware', 'Software', and 'Hardware & Software'. Also assume that your smart form has 2 tabs - 'Hardware' and 'Software'. Now if you have a smart form requirement to control the tabs based on the value of service type selected -
Case 1: If service type is 'Hardware & Software' - all tabs i.e. 'Hardware' and 'Software' should be available to user.
Case 2: If service type is 'Hardware', User should only see tab 'Hardware'.
Case 3: If service type is 'Software', User should only see tab 'Software'.
Tab Condition Set-up Configuration:
As per above example, Service Type is one of the fields on your Smart Form which contains 3 values - so it can be configured on AppDesigner using 'Dynamic List Box'. The settings required in Dynamic List Box Configuration to enable Tab Condition to achieve all the above 3 cases is described as follows:
Output screen /Facade Screen based on the above set-up are depicted below.
Note: Three Cases are displayed on basis of Case 1, 2 and 3 mentioned above
Currently App designer supports two types of tab configurations - 2 Layer Tab and Normal Tab.
Import Entity as JSON
App Designer allows importing business Entities from one environment to another by the Import feature under the Entity Menu.
Go to Left top Entity Menu > Entity > Import Entity
Browse and select the JSON entity file and import the Entity to the current environment.
2 Layer Tab is used for more complex Smart Forms where the business data require smart forms with an upper and lower tab representation. 2-Layer Tab design helps to split long forms into multiple pages to improve user experience. 2 Layer Tab design are used when upper and lower layer structure is required in your Smart Form layout, the top (Upper) tab in the configuration is always assigned as 'General Tab' in Tab description.
All tab settings that can be controlled under Tab configuration are described below
Tab Item
Default value
Mandatory
Description
Tab ID
N/A
Y
TAB ID is unique value and it's generated by system automatically.
Tab Description
General
Y
Defaulted by system and user can't edit tab Description
Table Name
N/A
Y
User Can edit and enter any Tab name as per requirement and business needs.
TabType
Y
Second (Lower) tab that is below the Primary (upper) tab is assigned as 'Main Tab' in tab description. The other tabs in the lower layer are all marked as 'Child Tabs' in an Entity. You can drag multiple 'Normal Tabs' inside your Entity to construct a desired output. Example below show a 2-Layer Tab design, with "Occurrence Information" as General Tab (upper Tab), RM Classification - as Main tab followed by 3 Child Normal tabs - Patient, Solution and Attachment.
FACADE SCREEN (User Experience) CONFIGURATION SCREEN (App Designer)
Tab Configuration of all Lower Tabs (i.e. Main Tab and all Child Tabs) as per given example are shown below:
Entities designed on ONEWEB Platform are portable. These Entities can be exported or imported as JSON data.
Export Entity as JSON: AppDesigner allows exporting business Entities from your current working environment to a different environment or any portable storage device using the export feature under the Entity Menu.
Go to top left Entity Menu > Entity > Export Entity
Select an existing Entity under select Entity preference and click on Export Entity.
Selected Entity will be saved to the local machine and can be easily exported to any other environment or storage devices.
Note: Please understand that if there are child entities for the entity that is exported / imported, then the child entities are not exported / imported by default. Each entity needs to be individually exported and imported.
Normal Tab is used to create a smart form with only one layer (simple one-page form designs). You can include multiple sections or modules within this tab. In Normal Tab design, the top first tab is always known as Main Tab in Tab description. All tab configuration settings that can be controlled under Tab configuration are described below -
Tab Item
Default value
Mandatory
Description
Tab ID
Y
Y
TAB ID is unique value and it's generated by system automatically.
Tab Description
Main
Y
Defaulted by system and user can't edit tab Description
Table Name
Normal
Y
User should edit and give Tab name as per requirement and business needs.
TabType
N
Example of Normal tab:
FACADE SCREEN (User Experience) CONFIGURATION SCREEN (App Designer)
Buttons are used inside Smart Forms to execute certain actions. App Designer supports 3 Types of Button Configuration inside your smart form - Entity Button, Module Button and Process button.
Entity Button: Entity buttons facilitates actions for the entire entity e.g. submitting the form, database calls such as Save/Cancel/Back/Approve or Reject actions on your smart form. Entity buttons can be dragged and dropped between Main Tab and Main module of your Entity. The Entity Button configuration provide a list of property settings with 2 icons as shown below:
- This Icon is used to open Button Configuration popup. Entity Button configuration popup provides a list of settings which can help configure your entity effectively. Entity Button Configuration settings along with their usage are listed in table below:
Button Item
Default value
Mandatory
Description
Button ID
System generated
Y
Button ID is unique, and it is generated by system.
Entity_ID
System generated
Y
System auto-displays the Entity ID associated with resp. Button.
buttonName
Default system generated no.
Y
User can edit default value to any value as per business needs.
Sequence
0
Y
Sequence is used to sequence the buttons while displaying on facade screen. Button with sequence '0' would show before button with sequence '1' and so on.
Button Type
button
Y
Button Type
Page Action
N/A
Y
Page Action has 3 types - ENTITY_SEARCH, ENTITY_INSERT & ENTITY_UPDATE
ENTITY_SEARCH is the page action used to display buttons on search screen/Search entity mode.
ENTITY_INSERT is the page action used to display buttons on insert screen/Insert entity mode.
ENTITY_UPDATE is the page action used to display buttons on update screen/Update entity mode.
Button Action
N/A
Y
There are 7 inbuilt Button actions provided by ONEWEB - searchResult(), resetSearchCriteria(), addEntity(), cancelEntity(), deleteEntity(), viewHistory() & saveEntity(). The use of each of the inbuilt button functions are listed below:
searchResult() is used to search for existing records from database based on search criteria.
resetSearchCriteria() is used to reset the search criteria .
addEntity() is used to open an entity screen to enter data.
cancelEntity() is used to close the entity edit screen.
deleteEntity() is used to delete record from database.
viewHistory() is used to show the history of the respective screen.
saveEntity() is used to save the data in the entity to the corresponding database tables.
Note: User can use any customize functions here instead of inbuilt functions, to perform a customized button action.
Authentication
No
Enable to call authorization Engine (IAM- Identity access Management)
Action
N/A
-
styleClass
button_style
Y
Custom Style Of CSS
sourceTag
N/A
Used to define button styles using HTML commands.
imgFlag
N/A
To show the button as image
Module Button: Facilitates user actions for 1-Many module in an entity. The scope of module buttons is limited to module levels and would not impact an entire Entity. It can be used to add, delete or update records of the module. The Module Button contains the same configuration settings as an Entity button as shown above, except different options available for Button Actions specific to modules. The Button action configuration options specific to module configuration are shown below:
Button Item
Default value
Mandatory
Description
Button Action
N/A
Y
ONEWEB smart form provides 7 inbuilt Button actions w.r. Module Button Configuration:
[MODULE_ID]Delete() - This action is used to delete Module Record.
actionFormSubmitOnTable( 'insertMany','Y')
[MODULE_ID]Copy() - This button is used for Copy Record.
actionFormSubmit( 'insertMany','Y') - This button is used for Pop-up logging into the Many module (Hashmap)
[MODULE_ID]ImportExcel() - This button is used for Import Excel to the Module Many table.
[MODULE_ID]ExportExcel() - This button is used for Export Table to Excel.
$( '#many_[MODULE_ID]_dialog('close'); This button is used to close the Module popup.
popupList('[POPUP_ENTITY_ID]','[CURRENT_MODULE_ID]') - This button is used to open the Neighbor Tab or to open the Popup Entity.
popupActionFlow('[MODULE_ID]') - This button is used to open popup.
Note: User can use any customize functions here instead of inbuilt functions, to perform a customized button action.
Process Button: Facilitates smart forms to connect with internal business processes & micro flows. Process buttons can be easily dragged and dropped beside entity button inside your entity. The Process Button configuration provide a list of property settings with following 4 tabs as shown below:
Pre-Action: Describes any actions that user wanted to perform on an Entity before performing Process button action. It provides user 3 inbuilt options - cancelEntity(), deleteEntity() and savaEntity(). (Note: User can use any customize functions here instead of inbuilt functions, to perform a customized pre-action)
Process: Process tab provides list of configuration settings.
Process Tab Item
Description
Process Server Status
Shows Green Light for active connection.
Project
User must select their project in Process Designer from drop down list
Process
User must select their Process in Process Designer
Process Action
Action to choose for respective process -
Post Action: Describes any actions that user wanted to perform on an Entity after executing Process button action. It provides user 3 inbuilt options - cancelEntity(), deleteEntity() and savaEntity(). (Note: User can use any customize functions here instead of inbuilt functions, to perform a customized post action)
Other Settings are similar as other module buttons settings.
Process Button Item
Default value
Mandatory
Description
Button ID
System generated
Y
Button ID is unique, and it's generated by system.
Entity_ID
System generated
Y
System auto-displays an Entity ID associated with resp. Button.
buttonName
Default system generated no.
Y
Appropriate name for button as per business needs.
Sequence
0
Sequence is used to display buttons in sequence on facade screen. Button with sequence '0' would show before button with sequence '1' and so on.
Button Type
button
Page Action
N/A
Y
Page Action has 3 types - ENTITY_SEARCH, ENTITY_INSERT & ENTITY_UPDATE
ENTITY_SEARCH is used to display buttons on search screen/Search entity mode.
ENTITY_INSERT is used to display buttons on insert screen/Insert entity mode.
ENTITY_UPDATE is used to display buttons on update screen/Update entity mode.
Authentication
No
Enable to call authorization Engine ( IAM- Identity access Management)
Action
N/A
-
styleClass
button_style
Custom Style Of CSS
sourceTag
N/A
Used to define button styles using HTML commands.
imgFlag
N/A
To show the button as image.
(Note: For more information on Entity Modes, Check )
- This Icon is used to delete a Button from your Smart Form Layout.
(Note : For more information on Entity Modes, check )
