Project naming standards

Check ID
APP_0013

Category

Standards

Summary

This check will compare the name of your project elements to the naming standards you set. By default the Mendix Best Practices for Developers are used.

Options

This is a complex check that has many different options. See the tables below for all available options. In all cases where a name format is specified the following configuration options apply: - Use a regex in the format supported by the Mendix isMatch() string function. - In some cases (described in the table below) additional variables may be used such as %UserRole%, %EntityName%, %AttributeName%, etc. - In all cases where a regex is used as an option, if you leave it empty the check will be ignored.

Pass

The name of the element matches your standard.

Fail

The name of the element does not match your standard.

App Microflows

Option Name
Details

After Startup Microflow

Regex to match. Default: ASU_.*

Before Shutdown Microflow

Regex to match. Default: BSD_.*

Health Check Microflow

Regex to match. Default: HCH_.*

Page-Based Microflows

Option Name
Details

On Enter Event

Regex to match event. Default: OEN_.*

On Change Event

Regex to match event. Default: OCH_.*

On Leave Event

Regex to match event. Default: OLE_.*

Data Source Microflows

Regex to match event. Default: DS_.*

Action Button

Regex to match event. Default: ACT_.*

Restrict Page Flows

If TRUE, microflows that match your page-based naming standards may not be called by other microflows.

Layouts and Snippets

Option Name
Details

Layout for responsive (web)

Regex to match layout. Default: Responsive_.*

Layout for tablet (web)

Regex to match layout. Default: Tablet_.*

Layout for phone (web)

Regex to match layout. Default: Phone_.*

Layout for native phone

Regex to match layout. Default: NativePhone_.*

Layout for popup

Regex to match layout. Default: Popup_.*

Snippets

Regex to match snippets. Default: Snippet_.*

Integration Documents

Option Name
Details

Import Mapping

Regex to use for import mappings. Default: IMM_.*

Export Mapping

Regex to use for export mappings. Default: EMM_.*

XML Schema Definition

Regex to use for XML schema definitions. Default: XSD_.*

JSON Structure

Regex to use for JSON structures. Default: JSON_.*

Navigation & Home Pages

Option Name
Details

Navigation Microflows

Regex to use for navigation microflows. Default: NAV_.*

Default Homepage (desktop)

Regex to use for the default home page (desktop profile). Default: Home_Desktop_Default

Default Homepage (tablet)

Regex to use for the default home page (tablet profile). Default: Home_Tablet_Default

Default Homepage (mobile)

Regex to use for the default home page (mobile profile). Default: Home_Phone_Default

User Role Homepage (desktop)

Regex to use for the home page for the home page a user role (desktop profile). The variable %UserRole% can be used for the name of the applicable user role. Default: Home_Desktop_%UserRole%

User Role Homepage (tablet)

Regex to use for the home page for the home page a user role (tablet profile). The variable %UserRole% can be used for the name of the applicable user role. Default: Home_Tablet_%UserRole%

User Role Homepage (mobile)

Regex to use for the home page for the home page for a user role (mobile profile). The variable %UserRole% can be used for the name of the applicable user role. Default: Home_Phone_%UserRole%

Scheduled Events

Option Name
Details

Scheduled Event

Regex to use for scheduled events. Default: SCE_.*

Last updated