Usage Manual
This page describes how to configure and use the Mobile Offline plugin.
The plugin allows users to download a selected set of CMDBuild data, work without network connectivity, and synchronize approved changes when connectivity is restored.
Prerequisites
Before using the plugin:
- Mobile functionality must be enabled in CMDBuild
- The mobile application must be configured and accessible
- Users must be able to connect to the CMDBuild server to download datasets and synchronize changes
- The data model must contain the Classes, Processes, and Views included in the configured dataset
- At least one dataset must be configured
- Users must have permission to access the resources included in the dataset
Supported versions
The plugin is supported starting from:
- CMDBuild 4.0
- CMDBuild Mobile 4.0.0
Configuration
Plugin configuration
To configure the plugin, perform the following steps in the CMDBuild desktop application:
- Open the subscription section on administration and complete the required fields
- Install and enable the plugin through the Plugin Manager
After installation, a dedicated configuration page becomes available for dataset management.
Dataset configuration
A dataset defines which resources are available offline. A dataset may include:
- Classes
- Processes
- SQL Views
- Join Views
- Selected attributes
Depending on the dataset configuration, users can:
- View records
- Create records
- Modify records
- Delete records
Administrators can also define which attributes are editable. Read-only attributes remain visible but cannot be modified.
Classes support the following modes:
| Mode | Description |
|---|---|
| Read | Records can be viewed |
| Write | Records can be viewed and modified |
Processes and Views are always available in Read mode.
Datasets can also include:
- Static filters: predefined during configuration and always applied
- Dynamic filters: use relationships between selected classes to limit the amount of data downloaded to the device. Only related records matching the selected criteria are included in the offline package. During the download process, users select the record used to complete the filter criteria
Starting Offline Mode
To start Offline Mode:
- Sign in to the mobile application
- Open Settings → Start Offline Mode
- Select the dataset to download
- Complete any required dynamic filter selection
- Wait for dataset preparation to complete
- Download the generated data package
After the download is completed, the application restarts and displays an Offline Mode indicator. Users can continue working without a network connection.
How Offline Mode works
Offline Mode is based on a dataset, which defines exactly which data is downloaded and whether it can be modified while the device is disconnected.
When an offline session is started, CMDBuild generates a package containing:
- The data model required by the dataset
- Records matching the configured filters
- Lookup values required by forms and attributes
- Additional metadata required for offline operation
Only resources explicitly included in the dataset are available on the mobile device.
Synchronizing changes
When offline activities are completed:
- Exit Offline Mode from the application settings
- Wait while local changes are uploaded and synchronized
- The mobile application restarts
Changes performed offline are not applied immediately to the database. A notification is generated in CMDBuild, allowing administrators to review all detected modifications before applying them to the system.
Reviewing changes
To review synchronized modifications, install the desktop Custom Page included with the plugin.
Selecting Apply Changes from the synchronization notification opens a comparison interface that allows administrators to review and validate all detected differences before committing them to the system.
Changes are grouped into:
- Created Cards
- Removed Cards
- Modified Cards
Each change can be individually accepted or rejected.
Only approved changes are applied to the system.
This review process helps prevent unintended updates and provides full control over synchronized data.
Available features
The following resources and features are currently supported by the plugin.
| Feature | Available | Notes |
|---|---|---|
| Classes | Yes | Read and write operations are supported according to the dataset configuration |
| Processes | Yes | Read-only |
| SQL Views | Yes | Read-only |
| Join Views | Yes | Read-only |
| Custom Pages | Yes | Processes are displayed and managed through Custom Pages when working offline |
| Navigation Menu | Yes | Includes only resources configured in the dataset |
| Form and Field Features | Yes | Only features that do not require server-side requests |
| Quick Filters | Yes | QR code search is not supported |
| Maps | No | |
| Reports | No | |
| Dashboards | No | |
| Search Filters | No | |
| Advanced Filters | No | |
| Navigation Trees | No | |
| Scheduler Views | No | |
| Filter Views | No | |
| Custom Widgets | No | |
| Custom Context Menus | No | |
| History | No | |
| Relations | No | |
| No | ||
| Attachments | No | |
| Calendar | No |
Dataset recommendations
To improve download and synchronization performance:
- Include only the required classes, processes and views
- Limit the number of exported attributes
- Use filters whenever possible
- Avoid downloading unnecessary data
Smaller datasets generally provide faster downloads, reduced storage requirements, and a better overall user experience.