Back

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.

B

Base

Module base

BA

Auth TOTP

Module base_auth_totp

BL

Login as another user

Module base_login_as

A

AI

Module ai

AW

Approval Workflow

Module approval_workflow

K

Knowledge

Knowledge Description

M

mail

Module mail

O

Onboarding

Module onboarding

HU

Hmx_Universal_Features

Hmx_Universal_Features Description

HS

HMX Scheduled Action

Module hmx_scheduled_action

HO

HMX OLAP Base

Base integration layer for DuckDB OLAP analytics

FN

Firebase Notification

Module firebase_notification

IA

Ip_Address_Restriction

Ip_Address_Restriction Description

PM

Password_Management

Password_Management Description

CG

Core General

Core General Description

CF

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

base
base_auth_totp
base_login_as
ai
approval_workflow
knowledge
mail
onboarding
hmx_universal_features
hmx_scheduled_action
hmx_olap
firebase_notification
ip_address_restriction
password_management
core_general
core_forecast

Modules within the Platform & Integrations scope β€” often used together and share data models.

Prerequisites

  • Module core_product must be installed
  • Module product must be installed
  • Module webx must be installed
  • Module webx_dashboard must be installed

Installation Steps

Step 1: Install base

Install the Base module via hmx CLI.

hmx update install base --alias=default --noinput

Step 2: Install base_auth_totp

Install the Auth TOTP module via hmx CLI.

hmx update install base_auth_totp --alias=default --noinput

Step 3: Install base_login_as

Install the Login as another user module via hmx CLI.

hmx update install base_login_as --alias=default --noinput

Step 4: Install ai

Install the AI module via hmx CLI.

hmx update install ai --alias=default --noinput

Step 5: Install approval_workflow

Install the Approval Workflow module via hmx CLI.

hmx update install approval_workflow --alias=default --noinput

Step 6: Install knowledge

Knowledge Description

hmx update install knowledge --alias=default --noinput

Step 7: Install mail

Install the mail module via hmx CLI.

hmx update install mail --alias=default --noinput

Step 8: Install onboarding

Install the Onboarding module via hmx CLI.

hmx update install onboarding --alias=default --noinput

Step 9: Install hmx_universal_features

Hmx_Universal_Features Description

hmx update install hmx_universal_features --alias=default --noinput

Step 10: Install hmx_scheduled_action

Install the HMX Scheduled Action module via hmx CLI.

hmx update install hmx_scheduled_action --alias=default --noinput

Step 11: Install hmx_olap

Base integration layer for DuckDB OLAP analytics

hmx update install hmx_olap --alias=default --noinput

Step 12: Install firebase_notification

Install the Firebase Notification module via hmx CLI.

hmx update install firebase_notification --alias=default --noinput

Step 13: Install ip_address_restriction

Ip_Address_Restriction Description

hmx update install ip_address_restriction --alias=default --noinput

Step 14: Install password_management

Password_Management Description

hmx update install password_management --alias=default --noinput

Step 15: Install core_general

Core General Description

hmx update install core_general --alias=default --noinput

Step 16: Install core_forecast

Revenue Forecast Dashboard with Chart.js visualizations

hmx update install core_forecast --alias=default --noinput

Post-install Checks

πŸ’‘After installing, verify each module appears in hmx list-modules and check that their menus are reachable from the HMX UI navigation.

Overview

HMX module: base

πŸ’‘Technical identifier: 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

none

Data Models 33

ModelClassTypeFieldsSource
groupGroupextends group11auth.py
userUsernew31auth.py
groupGroupImpliedextends group2auth.py
userUserImpliedextends user0auth.py
groupGroupViewextends group0auth.py
basemodulecategoryModuleCategoryextends basemodulecategory0auth.py
userUserViewextends user0auth.py
baseactionactwindowBaseActionActWindowextends baseactionaction12base_action.py
baseactionserverBaseActionServerextends baseactionaction11base_action.py
baseactwindowcloseBaseActionActWindowcloseextends baseactionaction0base_action.py
baseactionclientBaseActionClientextends baseactionaction4base_action.py
baseactionreportBaseActionReportextends baseactionserver4base_action.py
basepartnerbankBasePartnerBanknew12base_bank.py
basecommentBaseCommentnew11base_comment.py
basedocumentaccessBaseDocumentAccessnew4base_document.py
baseloggerdataBaseLoggerDatanew12base_logger_data.py
baseBasenew0base_model.py
basemodelaccessBaseModelAccessInheritedextends basemodelaccess3base_model_restrict.py
basemodelBaseModelInheritedextends basemodel1base_module.py
basepartnerBasePartnernew11base_partner.py
basepartneraddressBasePartnerAddressnew10base_partner.py
basepartnertypeBasePartnerTypenew1base_partner.py
basepartneraddresstypeBasePartnerAddressTypenew1base_partner.py
testchildTestChildextends testparent1base_tests.py
testpartnerTestPartnerextends imagemixin3base_tests.py
testuserTestUsernew3base_tests.py
baseurlpatternBaseURLPatternnew7base_url.py
intervalscheduleIntervalScheduleextends intervalschedule1periodic_task.py
crontabscheduleCrontabScheduleextends crontabschedule1periodic_task.py
solarscheduleSolarScheduleextends solarschedule1periodic_task.py
clockedscheduleClockedScheduleextends clockedschedule1periodic_task.py
periodictaskPeriodicTaskextends periodictask3periodic_task.py
publisher_warranty_contractPublisherWarrantyContractnew0update.py

Group β€” key fields

FieldType
nameCharField
full_nameCharField
rule_groupsManyToManyField
menu_accessManyToManyField
view_accessManyToManyField
commentTextField
categoryForeignKey
colorIntegerField
shareBooleanField
is_profileBooleanField
is_restrictBooleanField

user β€” key fields

FieldType
THEME_CHOICES?
nameCharField
loginCharField
languageForeignKey
companyForeignKey
branchForeignKey
companiesManyToManyField
branchesManyToManyField
signatureTextField
shareBooleanField
themeCharField
ACTION_CHOICES?
action_modelCharField
action_idIntegerField
USER_TYPE_CHOICES?

GroupImplied β€” key fields

FieldType
impliedsManyToManyField
trans_impliedsManyToManyField

Security & Access

ACL rules: 132    Groups: 5

Access to export featurePortalPublicSettings ProfileInternal User Profile

Overview

HMX module: base_auth_totp

πŸ’‘Technical identifier: 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

basewebx

Data Models 1

ModelClassTypeFieldsSource
userUserextends user2base_users.py

User β€” key fields

FieldType
is_mfa_enabledBooleanField
mfa_secret_keyCharField

API Endpoints 10

MethodPath
GETpre_uid
GETREMOTE_ADDR
GET/web/login/totp
GETpre_uid
GETHX-Device-Type
GETUser-Agent
POST/web/login/totp
GETpre_uid
GETHX-Device-Type
GETUser-Agent

Security & Access

ACL rules: 2    Groups: 0

Overview

HMX module: base_login_as

πŸ’‘Technical identifier: 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

basewebx

Data Models 2

ModelClassTypeFieldsSource
userUserextends user0base_users.py
webxwebsiteWebxWebsiteextends webxwebsite0webx_website.py

API Endpoints 1

MethodPath
GETimpersonator_id

Security & Access

ACL rules: 1    Groups: 0

Overview

HMX module: ai

πŸ’‘Technical identifier: 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

basewebx

Data Models 2

ModelClassTypeFieldsSource
baseconfigparameterBaseConfigParameterextends baseconfigparameter0base_config_parameter.py
basereportBaseReportextends basereport1base_report.py

BaseReport β€” key fields

FieldType
is_hashyBooleanField

API Endpoints 14

MethodPath
GETmessage
GETsession_id
GETcontext
GETcontext_mentioned
GETmessage
GETsession_id
GETcontext
GETcontext_mentioned
GETdata
GETdata
GETdata
GETdata
GETdata
GET/attachments/{message_id}/{filename}

Security & Access

ACL rules: 3    Groups: 0

Overview

HMX module: approval_workflow

πŸ’‘Technical identifier: 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

basemailcore_general

Data Models 1

ModelClassTypeFieldsSource
approvalmixinApprovalMixinnew0mixins.py

Security & Access

ACL rules: 6    Groups: 0

Overview

Knowledge Description

πŸ’‘Technical identifier: 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

basewebx

Data Models 3

ModelClassTypeFieldsSource
articleArticlenew3knowledge_article.py
articleattachmentArticleAttachmentnew4knowledge_article_attachment.py
articlememberArticleMembernew4knowledge_article_member.py

article β€” key fields

FieldType
nameCharField
bodyTextField
iconCharField

articleattachment β€” key fields

FieldType
nameCharField
article_idIntegerField
fileFileField
sizeBigIntegerField

articlemember β€” key fields

FieldType
RoleChoices?
article_idForeignKey
user_idForeignKey
roleCharField

Security & Access

ACL rules: 3    Groups: 0

Overview

HMX module: mail

πŸ’‘Technical identifier: mail. See the Technical mode toggle at the top for full data model and API reference.

Module Information

πŸ“¦

Name

mail

🏷️

Version

1.0

πŸ“‚

Category

Hidden

πŸ”—

Depends

1 modules

Dependencies

base

Security & Access

ACL rules: 8    Groups: 0

Overview

HMX module: onboarding

πŸ’‘Technical identifier: 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

base

Security & Access

ACL rules: 4    Groups: 0

Overview

Hmx_Universal_Features Description

πŸ’‘Technical identifier: 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

baseproductcore_product

Data Models 6

ModelClassTypeFieldsSource
costcenterCostCenternew8cost_center.py
costcenteritemCostCenterItemnew9cost_center_item.py
costcenterruleCostCenterRulenew13cost_center_rule.py
costcenterdistributionCostCenterDistributionnew4cost_center_rule.py
costcentersettingCostCenterSettingnew2cost_center_setting.py
costcentertypeCostCenterTypenew6cost_center_type.py

costcenter β€” key fields

FieldType
nameCharField
codeCharField
descriptionTextField
activeBooleanField
companyForeignKey
branchForeignKey
cost_center_typeForeignKey
responsible_userForeignKey

costcenteritem β€” key fields

FieldType
nameCharField
cost_centerForeignKey
cost_center_distributionForeignKey
cost_center_modeCharField
percentageFloatField
currencyForeignKey
currency_amountDecimalField
companyForeignKey
dateDateField

costcenterrule β€” key fields

FieldType
nameCharField
productForeignKey
product_categoryForeignKey
partnerCharField
companyForeignKey
branchForeignKey
userForeignKey
priorityIntegerField
valid_fromDateField
valid_toDateField
activeBooleanField
descriptionTextField
cost_center_modeCharField

Security & Access

ACL rules: 6    Groups: 0

Overview

HMX module: hmx_scheduled_action

πŸ’‘Technical identifier: 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

base

Security & Access

ACL rules: 1    Groups: 0

Overview

Base integration layer for DuckDB OLAP analytics

πŸ’‘Technical identifier: 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

webx

Data Models 2

ModelClassTypeFieldsSource
basemodelBaseModelextends basemodel2base_model.py
olapbaseOlapBasenew0olap.py

BaseModel β€” key fields

FieldType
is_olapBooleanField
olap_last_syncDateTimeField

Security & Access

ACL rules: 1    Groups: 0

Overview

HMX module: firebase_notification

πŸ’‘Technical identifier: 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

base

Security & Access

ACL rules: 2    Groups: 0

Overview

Ip_Address_Restriction Description

πŸ’‘Technical identifier: 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

base

Data Models 4

ModelClassTypeFieldsSource
userUserextends user7base_users.py
ipaddressIpAddressnew3ip_address.py
dayrestrictedDayRestrictednew7ip_address.py
logloginLogLoginnew5log_login.py

User β€” key fields

FieldType
ip_address_login_toggleBooleanField
current_ip_addressCharField
ip_address_after_loginCharField
time_restrictedBooleanField
sidCharField
should_be_logged_outBooleanField
tzCharField

ipaddress β€” key fields

FieldType
nameCharField
ip_addressCharField
res_userForeignKey

dayrestricted β€” key fields

FieldType
nameCharField
DAY_CHOICES?
dayCharField
start_timeFloatField
end_timeFloatField
res_userForeignKey
tzCharField

Security & Access

ACL rules: 3    Groups: 0

Overview

Password_Management Description

πŸ’‘Technical identifier: 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

basecore_general

Data Models 2

ModelClassTypeFieldsSource
basecompanyBaseCompanyextends basecompany10base_company.py
userUserextends user1base_users.py

BaseCompany β€” key fields

FieldType
password_expiresIntegerField
password_lengthIntegerField
password_lowerIntegerField
password_upperIntegerField
password_numericIntegerField
password_specialIntegerField
password_strengthIntegerField
password_historyIntegerField
password_minimumIntegerField
password_is_activeBooleanField

User β€” key fields

FieldType
password_write_dateDateTimeField

Security & Access

ACL rules: 2    Groups: 0

Overview

Core General Description

πŸ’‘Technical identifier: 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

basewebx

Data Models 2

ModelClassTypeFieldsSource
baseexecutequeryBaseExecuteQueryextends baseexecutequery0base_executequery.py
visionreportVisionReportnew9vision_report.py

visionreport β€” key fields

FieldType
nameCharField
descriptionTextField
menu_nameCharField
parent_menuForeignKey
sequenceIntegerField
stateCharField
lines_dataJSONField
created_menu_idForeignKey
created_action_idForeignKey

Security & Access

ACL rules: 5    Groups: 0

Overview

Revenue Forecast Dashboard with Chart.js visualizations

πŸ’‘Technical identifier: 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

basewebxwebx_dashboard

Data Models 2

ModelClassTypeFieldsSource
forecastForecastnew21forecast.py
forecast_fieldForecastFieldnew9forecast.py

forecast β€” key fields

FieldType
THEME_CHOICES?
MODEL_CHOICES?
TIME_GRAIN_CHOICES?
CUSTOM_INT_CHOICES?
STATE_CHOICES?
nameCharField
themeCharField
modelForeignKey
start_dateDateField
end_dateDateField
date_fieldForeignKey
model_typeCharField
time_grainCharField
custom_intervalIntegerField
custom_interval_typeCharField

forecast_field β€” key fields

FieldType
OP_CHOICES?
TYPE_CHOICES?
forecastForeignKey
fieldForeignKey
field_nameCharField
operatorCharField
chart_typeCharField
colorCharField
unitCharField

Security & Access

ACL rules: 4    Groups: 0

All Data Models 60

ModuleModelClassFields
aibaseconfigparameterBaseConfigParameter0
aibasereportBaseReport1
approval_workflowapprovalmixinApprovalMixin0
basebaseBase0
basebaseactionactwindowBaseActionActWindow12
basebaseactwindowcloseBaseActionActWindowclose0
basebaseactionclientBaseActionClient4
basebaseactionreportBaseActionReport4
basebaseactionserverBaseActionServer11
basebasecommentBaseComment11
basebasedocumentaccessBaseDocumentAccess4
basebaseloggerdataBaseLoggerData12
basebasemodelaccessBaseModelAccessInherited3
basebasemodelBaseModelInherited1
basebasepartnerBasePartner11
basebasepartneraddressBasePartnerAddress10
basebasepartneraddresstypeBasePartnerAddressType1
basebasepartnerbankBasePartnerBank12
basebasepartnertypeBasePartnerType1
basebaseurlpatternBaseURLPattern7
baseclockedscheduleClockedSchedule1
basecrontabscheduleCrontabSchedule1
basegroupGroup11
basegroupGroupImplied2
basegroupGroupView0
baseintervalscheduleIntervalSchedule1
basebasemodulecategoryModuleCategory0
baseperiodictaskPeriodicTask3
basepublisher_warranty_contractPublisherWarrantyContract0
basesolarscheduleSolarSchedule1
basetestchildTestChild1
basetestpartnerTestPartner3
basetestuserTestUser3
baseuserUser31
baseuserUserImplied0
baseuserUserView0
base_auth_totpuserUser2
base_login_asuserUser0
base_login_aswebxwebsiteWebxWebsite0
core_forecastforecastForecast21
core_forecastforecast_fieldForecastField9
core_generalbaseexecutequeryBaseExecuteQuery0
core_generalvisionreportVisionReport9
hmx_olapbasemodelBaseModel2
hmx_olapolapbaseOlapBase0
hmx_universal_featurescostcenterCostCenter8
hmx_universal_featurescostcenterdistributionCostCenterDistribution4
hmx_universal_featurescostcenteritemCostCenterItem9
hmx_universal_featurescostcenterruleCostCenterRule13
hmx_universal_featurescostcentersettingCostCenterSetting2
hmx_universal_featurescostcentertypeCostCenterType6
ip_address_restrictiondayrestrictedDayRestricted7
ip_address_restrictionipaddressIpAddress3
ip_address_restrictionlogloginLogLogin5
ip_address_restrictionuserUser7
knowledgearticleArticle3
knowledgearticleattachmentArticleAttachment4
knowledgearticlememberArticleMember4
password_managementbasecompanyBaseCompany10
password_managementuserUser1

All API Endpoints 25

ModuleMethodPath
base_auth_totpGETpre_uid
base_auth_totpGETREMOTE_ADDR
base_auth_totpGET/web/login/totp
base_auth_totpGETpre_uid
base_auth_totpGETHX-Device-Type
base_auth_totpGETUser-Agent
base_auth_totpPOST/web/login/totp
base_auth_totpGETpre_uid
base_auth_totpGETHX-Device-Type
base_auth_totpGETUser-Agent
base_login_asGETimpersonator_id
aiGETmessage
aiGETsession_id
aiGETcontext
aiGETcontext_mentioned
aiGETmessage
aiGETsession_id
aiGETcontext
aiGETcontext_mentioned
aiGETdata
aiGETdata
aiGETdata
aiGETdata
aiGETdata
aiGET/attachments/{message_id}/{filename}