Skip to main content

Mendix OIT Best Practices

Design
Naming Conventions
Microflows
APIs

Use the BYU Starter App to get the BYU layout.

Make sure to include enough information on your home page so that people know what your app does, and exactly what information they need to fill in to get started.

Make button text describe the action it will take.

If applicable, use the Mendix navigation to allow people to navigate from page to page.

Use Mendix naming conventions as outlined in https://docs.mendix.com/howto/general/dev-best-practices/

Make microflows efficient, especially when calling APIs or interacting with the database

You usually want to retrieve from the database toward the beginning of your microflow. Instead of retrieving multiple items or smaller lists in a loop, retrieve a larger list outside the loop, and filter it inside the loop.

Only commit an object once per microflow

If you have multiple objects to commit, save them to a list and commit the entire list together. Same goes for delete.

If possible, get large data sets from an API as a single batch call rather than a bunch of individual calls

Be very careful with nested loops. Sometimes they’re unavoidable, but they can really slow an application down or cause it to hang.

To make your microflow as readable as possible, make sure it follows the “happy path” from left to right. This means that the most common or expected path of your microflow follows a clear path from left to right. When using decisions, the True path should point to the right, and it should be the expected result, while False should usually be the less common or error case and it should point up or down.

Make sure to account for error cases when you call an API. If the result is empty or unexpected, you may want to log the error. If it prevents something that the user is expecting, you could also display a message.