External Data

How Can I Store & Use Integrated Data in My Applications?

When using data acquired through integrations (for example, web services or REST services), you have two options for storing and using the data, which are described below.

Storing in Persistable Entities

This option means that the data is stored in an application database. This is a good option if you want to use the data for a longer period (as in, hours or days), or if you want to share the data with different users of your application. Another reason to store integration data is when the services you depend on are slow or regularly unavailable.

Storing in Memory via Non-Persistable Entities

This option means that only the user session that retrieved the data has access to the data for the duration of their session. This can be a valid option if you need the data for a short period of time and you want to ensure that it is always in sync with the owner of the data (meaning, the service that provided the data).

Mendix’s export and import mappings provide support for both persistable and non-persistable entities.

How Does Mendix Support Direct Access to an External SQL Database?

The Database Connector available in the Mendix Marketplace can be used to run SQL actions on any database you are using. The database connector supports queries as well as actions like updates, deletes, and stored procedure calls.

The Database Connector works well with relational databases that support JDBC. Some NoSQL databases also include for SQL through JDBC, so for these NoSQL databases, you may also be able to use the Database Connector. Most NoSQL databases also offer connectivity through REST APIs. If this is the case, you can use Mendix’s extensive REST support to use data in these databases.

How Can I Import & Export Data from Sources like Excel?

Right out of the box, the data grid widget enables you to provide an Excel export of the data displayed in a data grid to your application users. For the bulk import or export of data in the Excel format, you can use the following two Mendix Marketplace modules:

  • Excel Importer – This module allows you to define templates for the different Excel sheets you want to import. A template defines the data provided in a sheet as well as how it should be mapped and converted to the entities defined in your Mendix application. You can reuse these templates if you regularly upload the same sheets with updated data.
  • Excel Exporter – This module allows you to define templates for how you want to export data from your Mendix application as an Excel sheet. Using these templates, you can regularly export data in the exact same formatted Excel sheet. For more information, see How to Use the Excel Exporter in the Mendix Studio Pro How-to’s.

How Can I Import & Export CSV-Formatted Data?

The Mendix Marketplace contains multiple modules that can help you import or export CSV-formatted data:

  • Excel Export – This module also supports exporting to the CSV format.
  • Flat & Delimited File Import – This module allows you to import flat and delimited files (CSV) from configuration in the runtime only, relieving you of the Java work.
  • Flat & Delimited File Export – This module makes exporting fixed length and delimited files (CSV) easy, as it handles all the Java coding and allows you to easily export your data from a microflow.
  • Simple CSV Exporter – This module is used for exporting to CSV from a microflow.
  • CSV Services – This module is the easiest and fastest way to get Excel data in and out of Mendix applications. It creates a REST endpoint for every entity in your application, allowing you to upload and download data in comma-separated values format. It also provides microflow actions for importing and exporting CSV in microflows.

How Can I Import & Export Fixed-Length & Delimited Files?

Some of the modules above support fixed-length and delimited files.

If you cannot find a module with support for your specific fixed-length format, using the Mendix Connector Kit to create a custom microflow action to handle import and export may be an option. For more info on the Connector Kit and Mendix Java APIs to provide microflow extensions, see the section How Can I Extend the Functionality of the Mendix Platform? in Extensibility.

How Can I Mass Export & Import?

There are a number of ways you can mass export and import data from your Mendix applications:

  • Custom build services – Examples of this are using web services or REST services. The benefit of this approach is that it enables you to adapt the data and validate it complies with your business rules.
  • Backup and restore – You can use custom (SQL) scripts to fill a Mendix development database with the data you need. When done, you create a backup of this database and restore it in the desired destination database.
  • Source database – When you start a runtime on a new empty database, you can specify that it needs to be initialized with data from another database.

If you want to create a real-time mass synchronization between two environments, you can use entity event listeners. This enables you to run custom Java logic for every object event (for example, when data is changed in your database). In this custom handler, you can provide logic to duplicate the data changes to another app.