Skip to content
Mile V3
Introduction
API Design Guide
UI UX Design Guide
Infrastructure
Module Configuration
Product Lifecycle
Roadmap
TDL
Billing Module
More
Share
Explore

icon picker
Module Configuration


⁠
image.png
⁠
b
Module configuration should be under the /platform collection, platform collection is where the platform settings are written
When they are enabled or disabled for an organization, the modules are rewritten under organization/module
example of a module data
{
module_id : 1,
module_name : Task,
module_description : “This module is use to manage task and its derivative such as, task-schedule and task-filter”
module_parent : Main,
module_type : public,
module_menu_icon : abc,
module_dependency : [settings]
module_permission :
[
module_permission_name : task-create,
module-permission_description : “can view task”
module_permission_endpoint : “/task”
module_permission_method_allowed : “GET”
module_permission_scope : “own/team/location/organization”
module_permission_data : “*”
],
}
Object Properties
0
Key
Type
Description
1
module_id
Integer
Autogenerated / Auto Increment
2
module_name
Alphanumeric and ‘-’
Name of the module, referred from or to other with this key
3
module_description
Text
Description of the module, will be shown on settings / module page
4
module_parent
Alphanumeric and ‘-’
If it is a submodule, this refers to its parental module, for main module, the parent is “main”
5
module_type
‘public’ or ‘private’
If public, it is shown to all users on settings / module and can be turned on off Private module is shown only to specific users
6
module_menu_icon
link to icon
Shown on menu or webpage
7
module_dependency
array of string(modules)
What are the modules they are dependent on, check for on and off
There are no rows in this table
7
Count
⁠

module_id : Autogenerated / Auto Increment
module_name : use to have
module_description : “This module is use to manage task and its derivative such as, task-schedule and task-filter”
module_parent : Main,
module_type : public,
module_menu_icon : abc,
module_dependency : [settings]


Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.