βοΈ Platform & Integrations
Framework core, auth, notifications, AI tooling, approvals, mail, onboarding and other horizontal services.
What's in this scope
The Platform & Integrations scope groups 16 HMX modules that together deliver end-to-end functionality for this area. Each module below focuses on a specific capability β click any card to jump to its documentation.
This scope comprises 16 Django apps under hmx/module/basic/, defining 60 models, 25 API endpoints, and 257 views collectively. Modules share dependencies and can be installed independently. External dependencies: core_product, product, webx, webx_dashboard.
Base
Module base
Auth TOTP
Module base_auth_totp
Login as another user
Module base_login_as
AI
Module ai
Approval Workflow
Module approval_workflow
Knowledge
Knowledge Description
Module mail
Onboarding
Module onboarding
Hmx_Universal_Features
Hmx_Universal_Features Description
HMX Scheduled Action
Module hmx_scheduled_action
HMX OLAP Base
Base integration layer for DuckDB OLAP analytics
Firebase Notification
Module firebase_notification
Ip_Address_Restriction
Ip_Address_Restriction Description
Password_Management
Password_Management Description
Core General
Core General Description
Core Forecast
Revenue Forecast Dashboard with Chart.js visualizations
Scope Statistics
16
Modules in scope
60
Data models
25
API endpoints
257
UI views
0
Menu items
91
Actions
Module Relationships
Modules within the Platform & Integrations scope β often used together and share data models.
Getting Started
Install, configure, and enable the Platform & Integrations scope in your HMX instance.
Prerequisites
- Module
core_productmust be installed - Module
productmust be installed - Module
webxmust be installed - Module
webx_dashboardmust be installed
Installation Steps
Step 1: Install base
Install the Base module via hmx CLI.
Step 2: Install base_auth_totp
Install the Auth TOTP module via hmx CLI.
Step 3: Install base_login_as
Install the Login as another user module via hmx CLI.
Step 4: Install ai
Install the AI module via hmx CLI.
Step 5: Install approval_workflow
Install the Approval Workflow module via hmx CLI.
Step 6: Install knowledge
Knowledge Description
Step 7: Install mail
Install the mail module via hmx CLI.
Step 8: Install onboarding
Install the Onboarding module via hmx CLI.
Step 9: Install hmx_universal_features
Hmx_Universal_Features Description
Step 10: Install hmx_scheduled_action
Install the HMX Scheduled Action module via hmx CLI.
Step 11: Install hmx_olap
Base integration layer for DuckDB OLAP analytics
Step 12: Install firebase_notification
Install the Firebase Notification module via hmx CLI.
Step 13: Install ip_address_restriction
Ip_Address_Restriction Description
Step 14: Install password_management
Password_Management Description
Step 15: Install core_general
Core General Description
Step 16: Install core_forecast
Revenue Forecast Dashboard with Chart.js visualizations
Post-install Checks
hmx list-modules and check that their menus are reachable from the HMX UI navigation.Base
HMX module: base
Overview
HMX module: base
base. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Base
Version
1.1
Category
Hidden
Depends
0 modules
Dependencies
Data Models 33
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| group | Group | extends group | 11 | auth.py |
| user | User | new | 31 | auth.py |
| group | GroupImplied | extends group | 2 | auth.py |
| user | UserImplied | extends user | 0 | auth.py |
| group | GroupView | extends group | 0 | auth.py |
| basemodulecategory | ModuleCategory | extends basemodulecategory | 0 | auth.py |
| user | UserView | extends user | 0 | auth.py |
| baseactionactwindow | BaseActionActWindow | extends baseactionaction | 12 | base_action.py |
| baseactionserver | BaseActionServer | extends baseactionaction | 11 | base_action.py |
| baseactwindowclose | BaseActionActWindowclose | extends baseactionaction | 0 | base_action.py |
| baseactionclient | BaseActionClient | extends baseactionaction | 4 | base_action.py |
| baseactionreport | BaseActionReport | extends baseactionserver | 4 | base_action.py |
| basepartnerbank | BasePartnerBank | new | 12 | base_bank.py |
| basecomment | BaseComment | new | 11 | base_comment.py |
| basedocumentaccess | BaseDocumentAccess | new | 4 | base_document.py |
| baseloggerdata | BaseLoggerData | new | 12 | base_logger_data.py |
| base | Base | new | 0 | base_model.py |
| basemodelaccess | BaseModelAccessInherited | extends basemodelaccess | 3 | base_model_restrict.py |
| basemodel | BaseModelInherited | extends basemodel | 1 | base_module.py |
| basepartner | BasePartner | new | 11 | base_partner.py |
| basepartneraddress | BasePartnerAddress | new | 10 | base_partner.py |
| basepartnertype | BasePartnerType | new | 1 | base_partner.py |
| basepartneraddresstype | BasePartnerAddressType | new | 1 | base_partner.py |
| testchild | TestChild | extends testparent | 1 | base_tests.py |
| testpartner | TestPartner | extends imagemixin | 3 | base_tests.py |
| testuser | TestUser | new | 3 | base_tests.py |
| baseurlpattern | BaseURLPattern | new | 7 | base_url.py |
| intervalschedule | IntervalSchedule | extends intervalschedule | 1 | periodic_task.py |
| crontabschedule | CrontabSchedule | extends crontabschedule | 1 | periodic_task.py |
| solarschedule | SolarSchedule | extends solarschedule | 1 | periodic_task.py |
| clockedschedule | ClockedSchedule | extends clockedschedule | 1 | periodic_task.py |
| periodictask | PeriodicTask | extends periodictask | 3 | periodic_task.py |
| publisher_warranty_contract | PublisherWarrantyContract | new | 0 | update.py |
Group β key fields
| Field | Type |
|---|---|
| name | CharField |
| full_name | CharField |
| rule_groups | ManyToManyField |
| menu_access | ManyToManyField |
| view_access | ManyToManyField |
| comment | TextField |
| category | ForeignKey |
| color | IntegerField |
| share | BooleanField |
| is_profile | BooleanField |
| is_restrict | BooleanField |
user β key fields
| Field | Type |
|---|---|
| THEME_CHOICES | ? |
| name | CharField |
| login | CharField |
| language | ForeignKey |
| company | ForeignKey |
| branch | ForeignKey |
| companies | ManyToManyField |
| branches | ManyToManyField |
| signature | TextField |
| share | BooleanField |
| theme | CharField |
| ACTION_CHOICES | ? |
| action_model | CharField |
| action_id | IntegerField |
| USER_TYPE_CHOICES | ? |
GroupImplied β key fields
| Field | Type |
|---|---|
| implieds | ManyToManyField |
| trans_implieds | ManyToManyField |
Security & Access
ACL rules: 132 Groups: 5
Auth TOTP
HMX module: base_auth_totp
Overview
HMX module: base_auth_totp
base_auth_totp. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Auth TOTP
Version
1.0
Category
authentication
Depends
2 modules
Dependencies
Data Models 1
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| user | User | extends user | 2 | base_users.py |
User β key fields
| Field | Type |
|---|---|
| is_mfa_enabled | BooleanField |
| mfa_secret_key | CharField |
API Endpoints 10
| Method | Path |
|---|---|
| GET | pre_uid |
| GET | REMOTE_ADDR |
| GET | /web/login/totp |
| GET | pre_uid |
| GET | HX-Device-Type |
| GET | User-Agent |
| POST | /web/login/totp |
| GET | pre_uid |
| GET | HX-Device-Type |
| GET | User-Agent |
Security & Access
ACL rules: 2 Groups: 0
Login as another user
HMX module: base_login_as
Overview
HMX module: base_login_as
base_login_as. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Login as another user
Version
1.0
Category
Extra Tools
Depends
2 modules
Dependencies
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| user | User | extends user | 0 | base_users.py |
| webxwebsite | WebxWebsite | extends webxwebsite | 0 | webx_website.py |
API Endpoints 1
| Method | Path |
|---|---|
| GET | impersonator_id |
Security & Access
ACL rules: 1 Groups: 0
AI
HMX module: ai
Overview
HMX module: ai
ai. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
AI
Version
1.0
Category
Hidden
Depends
2 modules
Dependencies
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| baseconfigparameter | BaseConfigParameter | extends baseconfigparameter | 0 | base_config_parameter.py |
| basereport | BaseReport | extends basereport | 1 | base_report.py |
BaseReport β key fields
| Field | Type |
|---|---|
| is_hashy | BooleanField |
API Endpoints 14
| Method | Path |
|---|---|
| GET | message |
| GET | session_id |
| GET | context |
| GET | context_mentioned |
| GET | message |
| GET | session_id |
| GET | context |
| GET | context_mentioned |
| GET | data |
| GET | data |
| GET | data |
| GET | data |
| GET | data |
| GET | /attachments/{message_id}/{filename} |
Security & Access
ACL rules: 3 Groups: 0
Approval Workflow
HMX module: approval_workflow
Overview
HMX module: approval_workflow
approval_workflow. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Approval Workflow
Version
1.0
Category
approval
Depends
3 modules
Dependencies
Data Models 1
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| approvalmixin | ApprovalMixin | new | 0 | mixins.py |
Security & Access
ACL rules: 6 Groups: 0
Knowledge
Knowledge Description
Overview
Knowledge Description
knowledge. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Knowledge
Version
1.0.0
Category
Knowledge Category
Depends
2 modules
Dependencies
Data Models 3
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| article | Article | new | 3 | knowledge_article.py |
| articleattachment | ArticleAttachment | new | 4 | knowledge_article_attachment.py |
| articlemember | ArticleMember | new | 4 | knowledge_article_member.py |
article β key fields
| Field | Type |
|---|---|
| name | CharField |
| body | TextField |
| icon | CharField |
articleattachment β key fields
| Field | Type |
|---|---|
| name | CharField |
| article_id | IntegerField |
| file | FileField |
| size | BigIntegerField |
articlemember β key fields
| Field | Type |
|---|---|
| RoleChoices | ? |
| article_id | ForeignKey |
| user_id | ForeignKey |
| role | CharField |
Security & Access
ACL rules: 3 Groups: 0
HMX module: mail
Overview
HMX module: mail
mail. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Version
1.0
Category
Hidden
Depends
1 modules
Dependencies
Security & Access
ACL rules: 8 Groups: 0
Onboarding
HMX module: onboarding
Overview
HMX module: onboarding
onboarding. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Onboarding
Version
1.0
Category
Hidden
Depends
1 modules
Dependencies
Security & Access
ACL rules: 4 Groups: 0
Hmx_Universal_Features
Hmx_Universal_Features Description
Overview
Hmx_Universal_Features Description
hmx_universal_features. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Hmx_Universal_Features
Version
1.0.0
Category
Hmx_Universal_Features Category
Depends
3 modules
Dependencies
Data Models 6
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| costcenter | CostCenter | new | 8 | cost_center.py |
| costcenteritem | CostCenterItem | new | 9 | cost_center_item.py |
| costcenterrule | CostCenterRule | new | 13 | cost_center_rule.py |
| costcenterdistribution | CostCenterDistribution | new | 4 | cost_center_rule.py |
| costcentersetting | CostCenterSetting | new | 2 | cost_center_setting.py |
| costcentertype | CostCenterType | new | 6 | cost_center_type.py |
costcenter β key fields
| Field | Type |
|---|---|
| name | CharField |
| code | CharField |
| description | TextField |
| active | BooleanField |
| company | ForeignKey |
| branch | ForeignKey |
| cost_center_type | ForeignKey |
| responsible_user | ForeignKey |
costcenteritem β key fields
| Field | Type |
|---|---|
| name | CharField |
| cost_center | ForeignKey |
| cost_center_distribution | ForeignKey |
| cost_center_mode | CharField |
| percentage | FloatField |
| currency | ForeignKey |
| currency_amount | DecimalField |
| company | ForeignKey |
| date | DateField |
costcenterrule β key fields
| Field | Type |
|---|---|
| name | CharField |
| product | ForeignKey |
| product_category | ForeignKey |
| partner | CharField |
| company | ForeignKey |
| branch | ForeignKey |
| user | ForeignKey |
| priority | IntegerField |
| valid_from | DateField |
| valid_to | DateField |
| active | BooleanField |
| description | TextField |
| cost_center_mode | CharField |
Security & Access
ACL rules: 6 Groups: 0
HMX Scheduled Action
HMX module: hmx_scheduled_action
Overview
HMX module: hmx_scheduled_action
hmx_scheduled_action. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
HMX Scheduled Action
Version
1.0
Category
β
Depends
1 modules
Dependencies
Security & Access
ACL rules: 1 Groups: 0
HMX OLAP Base
Base integration layer for DuckDB OLAP analytics
Overview
Base integration layer for DuckDB OLAP analytics
hmx_olap. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
HMX OLAP Base
Version
1.0.0
Category
β
Depends
1 modules
Dependencies
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| basemodel | BaseModel | extends basemodel | 2 | base_model.py |
| olapbase | OlapBase | new | 0 | olap.py |
BaseModel β key fields
| Field | Type |
|---|---|
| is_olap | BooleanField |
| olap_last_sync | DateTimeField |
Security & Access
ACL rules: 1 Groups: 0
Firebase Notification
HMX module: firebase_notification
Overview
HMX module: firebase_notification
firebase_notification. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Firebase Notification
Version
1.0
Category
notification
Depends
1 modules
Dependencies
Security & Access
ACL rules: 2 Groups: 0
Ip_Address_Restriction
Ip_Address_Restriction Description
Overview
Ip_Address_Restriction Description
ip_address_restriction. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Ip_Address_Restriction
Version
1.0.0
Category
Ip_Address_Restriction Category
Depends
1 modules
Dependencies
Data Models 4
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| user | User | extends user | 7 | base_users.py |
| ipaddress | IpAddress | new | 3 | ip_address.py |
| dayrestricted | DayRestricted | new | 7 | ip_address.py |
| loglogin | LogLogin | new | 5 | log_login.py |
User β key fields
| Field | Type |
|---|---|
| ip_address_login_toggle | BooleanField |
| current_ip_address | CharField |
| ip_address_after_login | CharField |
| time_restricted | BooleanField |
| sid | CharField |
| should_be_logged_out | BooleanField |
| tz | CharField |
ipaddress β key fields
| Field | Type |
|---|---|
| name | CharField |
| ip_address | CharField |
| res_user | ForeignKey |
dayrestricted β key fields
| Field | Type |
|---|---|
| name | CharField |
| DAY_CHOICES | ? |
| day | CharField |
| start_time | FloatField |
| end_time | FloatField |
| res_user | ForeignKey |
| tz | CharField |
Security & Access
ACL rules: 3 Groups: 0
Password_Management
Password_Management Description
Overview
Password_Management Description
password_management. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Password_Management
Version
1.0.0
Category
Password_Management Category
Depends
2 modules
Dependencies
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| basecompany | BaseCompany | extends basecompany | 10 | base_company.py |
| user | User | extends user | 1 | base_users.py |
BaseCompany β key fields
| Field | Type |
|---|---|
| password_expires | IntegerField |
| password_length | IntegerField |
| password_lower | IntegerField |
| password_upper | IntegerField |
| password_numeric | IntegerField |
| password_special | IntegerField |
| password_strength | IntegerField |
| password_history | IntegerField |
| password_minimum | IntegerField |
| password_is_active | BooleanField |
User β key fields
| Field | Type |
|---|---|
| password_write_date | DateTimeField |
Security & Access
ACL rules: 2 Groups: 0
Core General
Core General Description
Overview
Core General Description
core_general. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Core General
Version
1.0.0.0.2
Category
Core General Category
Depends
2 modules
Dependencies
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| baseexecutequery | BaseExecuteQuery | extends baseexecutequery | 0 | base_executequery.py |
| visionreport | VisionReport | new | 9 | vision_report.py |
visionreport β key fields
| Field | Type |
|---|---|
| name | CharField |
| description | TextField |
| menu_name | CharField |
| parent_menu | ForeignKey |
| sequence | IntegerField |
| state | CharField |
| lines_data | JSONField |
| created_menu_id | ForeignKey |
| created_action_id | ForeignKey |
Security & Access
ACL rules: 5 Groups: 0
Core Forecast
Revenue Forecast Dashboard with Chart.js visualizations
Overview
Revenue Forecast Dashboard with Chart.js visualizations
core_forecast. See the Technical mode toggle at the top for full data model and API reference.Module Information
Name
Core Forecast
Version
1.0.0
Category
Forecast
Depends
3 modules
Dependencies
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| forecast | Forecast | new | 21 | forecast.py |
| forecast_field | ForecastField | new | 9 | forecast.py |
forecast β key fields
| Field | Type |
|---|---|
| THEME_CHOICES | ? |
| MODEL_CHOICES | ? |
| TIME_GRAIN_CHOICES | ? |
| CUSTOM_INT_CHOICES | ? |
| STATE_CHOICES | ? |
| name | CharField |
| theme | CharField |
| model | ForeignKey |
| start_date | DateField |
| end_date | DateField |
| date_field | ForeignKey |
| model_type | CharField |
| time_grain | CharField |
| custom_interval | IntegerField |
| custom_interval_type | CharField |
forecast_field β key fields
| Field | Type |
|---|---|
| OP_CHOICES | ? |
| TYPE_CHOICES | ? |
| forecast | ForeignKey |
| field | ForeignKey |
| field_name | CharField |
| operator | CharField |
| chart_type | CharField |
| color | CharField |
| unit | CharField |
Security & Access
ACL rules: 4 Groups: 0
Technical Reference
Complete registry of data models and API endpoints across all modules in this scope.
All Data Models 60
| Module | Model | Class | Fields |
|---|---|---|---|
| ai | baseconfigparameter | BaseConfigParameter | 0 |
| ai | basereport | BaseReport | 1 |
| approval_workflow | approvalmixin | ApprovalMixin | 0 |
| base | base | Base | 0 |
| base | baseactionactwindow | BaseActionActWindow | 12 |
| base | baseactwindowclose | BaseActionActWindowclose | 0 |
| base | baseactionclient | BaseActionClient | 4 |
| base | baseactionreport | BaseActionReport | 4 |
| base | baseactionserver | BaseActionServer | 11 |
| base | basecomment | BaseComment | 11 |
| base | basedocumentaccess | BaseDocumentAccess | 4 |
| base | baseloggerdata | BaseLoggerData | 12 |
| base | basemodelaccess | BaseModelAccessInherited | 3 |
| base | basemodel | BaseModelInherited | 1 |
| base | basepartner | BasePartner | 11 |
| base | basepartneraddress | BasePartnerAddress | 10 |
| base | basepartneraddresstype | BasePartnerAddressType | 1 |
| base | basepartnerbank | BasePartnerBank | 12 |
| base | basepartnertype | BasePartnerType | 1 |
| base | baseurlpattern | BaseURLPattern | 7 |
| base | clockedschedule | ClockedSchedule | 1 |
| base | crontabschedule | CrontabSchedule | 1 |
| base | group | Group | 11 |
| base | group | GroupImplied | 2 |
| base | group | GroupView | 0 |
| base | intervalschedule | IntervalSchedule | 1 |
| base | basemodulecategory | ModuleCategory | 0 |
| base | periodictask | PeriodicTask | 3 |
| base | publisher_warranty_contract | PublisherWarrantyContract | 0 |
| base | solarschedule | SolarSchedule | 1 |
| base | testchild | TestChild | 1 |
| base | testpartner | TestPartner | 3 |
| base | testuser | TestUser | 3 |
| base | user | User | 31 |
| base | user | UserImplied | 0 |
| base | user | UserView | 0 |
| base_auth_totp | user | User | 2 |
| base_login_as | user | User | 0 |
| base_login_as | webxwebsite | WebxWebsite | 0 |
| core_forecast | forecast | Forecast | 21 |
| core_forecast | forecast_field | ForecastField | 9 |
| core_general | baseexecutequery | BaseExecuteQuery | 0 |
| core_general | visionreport | VisionReport | 9 |
| hmx_olap | basemodel | BaseModel | 2 |
| hmx_olap | olapbase | OlapBase | 0 |
| hmx_universal_features | costcenter | CostCenter | 8 |
| hmx_universal_features | costcenterdistribution | CostCenterDistribution | 4 |
| hmx_universal_features | costcenteritem | CostCenterItem | 9 |
| hmx_universal_features | costcenterrule | CostCenterRule | 13 |
| hmx_universal_features | costcentersetting | CostCenterSetting | 2 |
| hmx_universal_features | costcentertype | CostCenterType | 6 |
| ip_address_restriction | dayrestricted | DayRestricted | 7 |
| ip_address_restriction | ipaddress | IpAddress | 3 |
| ip_address_restriction | loglogin | LogLogin | 5 |
| ip_address_restriction | user | User | 7 |
| knowledge | article | Article | 3 |
| knowledge | articleattachment | ArticleAttachment | 4 |
| knowledge | articlemember | ArticleMember | 4 |
| password_management | basecompany | BaseCompany | 10 |
| password_management | user | User | 1 |
All API Endpoints 25
| Module | Method | Path |
|---|---|---|
| base_auth_totp | GET | pre_uid |
| base_auth_totp | GET | REMOTE_ADDR |
| base_auth_totp | GET | /web/login/totp |
| base_auth_totp | GET | pre_uid |
| base_auth_totp | GET | HX-Device-Type |
| base_auth_totp | GET | User-Agent |
| base_auth_totp | POST | /web/login/totp |
| base_auth_totp | GET | pre_uid |
| base_auth_totp | GET | HX-Device-Type |
| base_auth_totp | GET | User-Agent |
| base_login_as | GET | impersonator_id |
| ai | GET | message |
| ai | GET | session_id |
| ai | GET | context |
| ai | GET | context_mentioned |
| ai | GET | message |
| ai | GET | session_id |
| ai | GET | context |
| ai | GET | context_mentioned |
| ai | GET | data |
| ai | GET | data |
| ai | GET | data |
| ai | GET | data |
| ai | GET | data |
| ai | GET | /attachments/{message_id}/{filename} |