Appe - Mobile App Module

The Mobile App Module doctype is used to organize features inside the Appe Mobile Application. Each module acts as a container that groups related navigation items such as DocTypes, Reports, Custom Screens, Web URLs, and other mobile actions.

A module can contain multiple Module Items, allowing you to build a customized navigation experience for your users.

---

Features

• Create unlimited mobile modules.
• Group related features together.
• Display custom module icons.
• Control the display order using Sequence ID.
• Add multiple navigation items.
• Open DocTypes, Reports, Screens, or Web URLs.
• Configure custom behavior using the JSON field.

---

Fields

Field	Description
Module Name	Name displayed in the mobile application.
Status	Enable or disable the module.
Image	Module icon displayed in the mobile application.
Sequence ID	Controls the display order of modules. Lower values appear first.

---

Module Items

Each module can contain multiple navigation items.

Field	Description
Active	Enable or disable the navigation item.
Label	Name displayed in the mobile application.
Type	Defines the action performed when the item is opened.
Linked DocType	DocType opened when the Type is set to DocType.
Reference Docname	Opens a specific document directly.
Report Name	Report opened when the Type is Report.
Screen Name	Custom mobile screen to open.
Web URL	External website to open.
JSON	Optional configuration used for custom screens and advanced actions.

---

JSON Examples

Apply Filters

---

Using the JSON Field

The JSON field allows you to pass additional configuration to the selected navigation item. The data stored in this field is sent to the mobile application when the user opens the item. It can be used to apply filters, pass default values, customize screen behavior, or send any additional parameters required by your custom mobile screen.

The structure of the JSON depends on the selected Type and how your mobile application handles the data.

Type	JSON Usage
DocType	Pass default values or filters while opening the list or creating a new document.
Report	Provide report filters or default filter values.
Screen	Send custom parameters required by the mobile screen.
Web URL	Optional. Pass query parameters if supported by the website.
Custom Action	Pass any custom payload required by your application.

---

Example 1 - DocType

Open the Customer list with predefined filters.

{
    "filters": {
        "customer_group": "Retail",
        "territory": "India"
    }
}

---

Example 2 - Report

Open a report with default filters.

{
    "filters": {
        "company": "My Company",
        "from_date": "2026-01-01",
        "to_date": "2026-12-31"
    }
}

---

Example 3 - Screen

Pass custom parameters to a mobile screen.

{
    "employee": "EMP-00001",
    "mode": "view",
    "show_history": true
}

---

Example 4 - Web URL

Pass additional parameters to an external website.

{
    "query": {
        "source": "appe",
        "lang": "en"
    }
}

---

Example 5 - Custom Action

Send a custom payload for your mobile application.

{
    "action": "scan_qr",
    "redirect": "Customer",
    "success_message": "Customer loaded successfully"
}

---

Note: The JSON field is completely flexible. You can store any valid JSON object based on your application's requirements. The mobile application or custom screen is responsible for reading and processing these values.

---

Create a Mobile App Module

1. Create a New Module

1. Go to Appe → Mobile App Module.
2. Click New.
3. Fill in the following details:
   • Module Name
   • Status
   • Image
   • Sequence ID
4. Click Save.

---

2. Add Module Items

1. Scroll down to the Items child table.
2. Click Add Row.
3. Configure the required fields.
4. Repeat the process to add multiple navigation items.

---

3. Save & View

1. Click Save.
2. Open the Appe Mobile App.
3. Log in to your account.
4. Navigate to the Home screen.

The newly created module will be displayed according to its Sequence ID.

---

Tips

• Keep the module Status set to Active.
• Use meaningful labels and icons.
• Arrange modules using Sequence ID.
• Group related features in the same module.
• Use the JSON field only for custom configurations.

---

Example

Label	Type
Customers	DocType
Sales Orders	DocType
Sales Analytics	Report
Company Website	Web URL

---

Summary

The Mobile App Module doctype is used to organize navigation inside the Appe Mobile Application. Each module can contain multiple items that open DocTypes, Reports, Custom Screens, Web URLs, and other mobile features from a single location.

{
    "filters": {
        "status": "Open",
        "company": "My Company"
    }
}

{
    "defaults": {
        "company": "My Company",
        "territory": "India"
    }
}

{
    "title": "Today's Visits",
    "icon": "map-marker",
    "color": "#2563EB",
    "show_badge": true
}

{
    "screen": "EmployeeTimeline",
    "employee": "EMP-00001"
}