User can use Menu Configuration to add their applications to the ONEWEB Menu.
Importance/Uses: Once a user develops any application using an App Designer, it can be easily added to the Menu so that other users can access the app. Once an application is successfully tested, an application user could use Access Management tool called IAM on ONEWEB platform to make it available only for eligible end users and easily restricts access to ineligible users or roles.
Steps to add your application on ONEWEB Menu: Below Snippet depicts an icon to add a menu item on ONEWEB Menu.
Example: To illustrate and guide in creating a Menu item, let's design a menu header labeled as "SAMPLE_APP" and under this header we allow end user to access the application named "Doc Order Request". The desired final output in this case should look like below:
To design a ONEWEB MENU as above, follow the steps given below:
Enter Description, Eg: Description is the title of the menu For e.g. SAMPLE_APP (Note:This is an example description, User can use descriptions text that suits their business needs)
Sequence - to set the order of Menu. Sequence '0' will appear before '1' and so on. For our purpose the sequence is set as "1".
Mapping - Mapping is used to open desired entity in either SEARCH or INSERT mode. But for a label menu item, you can leave it as blank as it is not mapped to any entity.
Reference - To set the hierarchy of the menu. If you want to make your menu come under a parent menu, you can put reference as the parent menu. But if you want your menu as the first level, you can leave it blank.
Type - There are 2 available types to choose from - LABEL and PAGE. LABEL is used to create a Menu label to group child menu items and PAGE is used to create a menu item inside that Label. E.g: To design an example as above we create "SAMPLE_APP" menu here is a label and under this label, we would place our application "Doc Order Request" as PAGE to design required MENU design.
Action Target - Choose as 'mainframe'
Click OK to save.
Once you are finished with above steps the Menu configuration screen should have an item with the name SAMPLE_APP. Follow instructions below to create an Menu item inside this Menu Label.
Enter Description, Eg: Description as "DOC Oder Request" (Note:This is an example description in, User can use descriptions text that suits their business application needs)
Enter Sequence to set order of Menu. Sequence '0' will appear before '1' and so on. E.g: Sequence is set as "1".
Mapping - Mapping is used to open desired entity in either SEARCH or INSERT mode. User can select the entity to be attached to the menu from the first drop down. User can then decide the specific mode based on their requirement. For our application purpose the INSERT mode is selected.
Note: For more information on different modes, please follow the section on Entity Modes
Click "Generate" button to generate auto script in Action URL.
Reference - System will default the Parent Menu ID.
Type - Choose PAGE in this case as we need to open the application from this menu.
Action Target - Choose as 'mainframe'.
Click OK to save.
Check below demonstration of above-mentioned steps:
Once finished with above steps. User should be able to see new MENU on ONEWEB MENU screen as below:
Note: User will need to refresh cache and then logout & Login again for the new changes to reflect on ONEWEB Menu.
App Designer UI provides a list of utilities which includes Menu configuration to design ONEWEB Menu designs, Parent Child Entities to link two entities together and establish relationship between them and Master Import/Export to import or export master setup data from one environment to another environment.User can access App designer Utilities via simply routing to DEV ZONE -> App Designer->
Each utility is described in more details in the sections below.
From version 4.0.0.19 onward, App Designer provides option to configure the datasource to be used on the App Designer. Once a datasource is configured, an entity can be configured to use this datasource to query the table details. This provides flexibility to user to connect to different data sources from the Smart Form.
To manage the Datasource, go to the Utilities Menu and click on the Datasource Configuration menu.
System will show the existing datasource configured in AD.
Enter the details of the new datasource on the Datasource configuration screen and click Save.
Once saved user can use the new datasource in an entity by setting the new datasource as the system code in entity configuration.
App Designer provides Master Import/Export utility to either import or export your master database setup from one environment to another environment. User can access Master Import/Export Utility via simply routing to DEV ZONE -> App Designer-> -> Master Import/Export. Master database setup tables include all necessary initial set up details like schema information and other internal technical configuration which user can select and export from one environment and import it to another environment as needed. The list of tables involves in Master database setup are:
m_metab_constant
m_metab_system
m_metab_button_process_action
m_metab_button_master
m_locales
m_process_menu
Master Configuration window under Export tab with all master data setup tables are shown below. All below mentioned tables can easily be exported as JSON files.
User can also Import master data setup from JSON files by simply browsing it or dragging and dropping it to the highlighted area. Master Configuration Import window with browse option are shown below:
Parent Child Utility on ONEWEB is used to link two entities together via linking the module keys from the main module of the two entities. So, if your business requirement needs complex smart form structures where you are required to create multiple entities and associate them together to capture any business needs, this could easily be achieved by using "Parent Child Entity" feature on ONEWEB.
User can access "Parent Child Utility" via simply routing to DEV ZONE -> App Designer-> -> Parent Child Entities as shown in steps (1-4) below:
By using this utility, an application user can easily specify the main Entity under "Parent Entity" and the other entity that is required to be linked under "Child Entity" on Parent Child Configuration screen. All other necessary settings required to use this utility are described below:
Parent child configuration window provides a list of settings which helps to configure parent child link effectively. All settings inside "Parent Child Entity" window are listed below:
Item
Default value
Mandatory
Description
Parent Entity
N/A
Y
Select the Parent Entity in this field.
Parent tab
N/A -
Y
Select the Tab from where the child entity is to be linked in this field.
Parent Module
N/A
Y
Select the Module from where the child entity is to be linked in this field.
Child Entity
N/A
Y
Select Child Entity in this Field
Child Tab
N/A
Y
Select the main Tab of Child entity in this Field
Parameter Passing
-
-
-
Parent's Fields*
N/A
Y
Key of the Parent Entity passed to the Child Entity
Interface Parameters*
N/A
Y
Parameters key pass to the Child Entity.
Child's Fields*
N/A
Y
Key of the Child Entity to be invoked from Child Entity screen.
Image btn
N/A
N
Allow Developers to use image button.
Display Value
N/A
Y
Button Name to be displayed on Parent Entity.
Sequence
N/A
N
Sequence of button. Sequence 0 will appear before sequence 1 and so on.
Style Class
N/A
N
Use for any CSS customization, if required.
Source Tag
N/A
N
Use for JavaScript Customization, if required.
User can configure any required button on Parent entity to redirect end user to another linked child entity. It makes creating complex smart forms easier and more user friendly. Note: To create a relationship between Parent and child entity, database design needs to be in a way that both Parent and Child entities linked with Parent table Primary keys and other necessary keys, if required.
Click on icon to open Menu Properties Window.
Click on icon to open Menu Properties Window.
User can create new Datasource by clicking on the Add icon .
Click on icon to open up new Parent Child configuration window on screen.
