Export To Excel (Generic)

Content Type: Module
Categories: Utility,Import/Export

Overview

ENGLISH

📥 Export To Excel (Generic) – Export any Mendix entity to Excel

This module allows you to export any persistent entity from your Mendix app into a fully styled Excel file using a single Java Action. You don’t need to manually define attributes — the module automatically detects and exports all fields of the specified object.

 

✅ Automatic styling

✅ Formatted headers

✅ Decimal number formatting

✅ Auto-sized columns

✅ Direct download from the browser

 

How it works

  1. Create an object that inherits from System.FileDocument

  2. Call the Java Action ExportEntityToExcel, passing:

    • The full name of the entity (e.g., MyModule.MyEntity)

    • The File object

  3. The Excel file is generated and immediately downloaded

 

Includes:

  • Example page

  • Microflow ACT_Download_Excel

  • Sample screenshots

  • Documentation in both English and Spanish

 

🔧 Compatible with Mendix 10.12.16+

🧩 Easy to integrate into any application

📄 License: MIT (free to use and modify)

 

Developed by: ** Pedro Arana del Blanco **

 

ESPAÑOL

📥 Exportar a Excel (Genérico) – Exporta cualquier entidad de Mendix a Excel

Este módulo te permite exportar cualquier entidad persistente de tu aplicación Mendix a un archivo Excel completamente estilizado utilizando una sola Java Action. No necesitas definir los atributos manualmente: el módulo detecta y exporta automáticamente todos los campos del objeto especificado.

 

✅ Estilo automático

✅ Cabeceras con formato

✅ Formato decimal aplicado

✅ Columnas autoajustadas

✅ Descarga directa desde el navegador

Cómo funciona

  1. Crea un objeto que herede de System.FileDocument

  2. Llama a la Java Action ExportEntityToExcel, pasando:

    • El nombre completo de la entidad (por ejemplo: MiModulo.MiEntidad)

    • El objeto File

  3. El archivo Excel se genera y se descarga automáticamente

Incluye:

  • Página de ejemplo

  • Microflujo ACT_Download_Excel

  • Capturas de ejemplo

  • Documentación en inglés y español

🔧 Compatible con Mendix 10.12.16+

🧩 Fácil de integrar en cualquier aplicación

📄 Licencia: MIT (libre para usar y modificar)

 

Desarrollado por: Pedro Arana del Blanco

Documentation

ENGLISH

🧩 Typical Usage Scenario

Export To Excel (Generic) is designed to help developers export any persistent entity from their Mendix application into a styled Excel file using a single Java Action. It solves the common problem of manually building export logic by dynamically retrieving entity attributes via the meta model.

It is ideal for:

  • Admin reports

  • Internal tools

  • Data analysis exports

  • Developer utilities

 

⚙️ Features and Limitations

Features:

  • Generic Java Action: no hardcoded attributes required

  • Automatically reads the entity structure from the meta model

  • Styled Excel export, including:

    • Bold header row

    • Decimal number formatting

    • Auto-sized columns

  • Direct file download from the browser

  • Easy to integrate into any microflow

  • Includes example microflow and page

Limitations:

  • Only works with persistent entities

  • Does not recursively export reference attributes (flat structure only)

  • File size may grow with large datasets (streaming not supported)

 

📥You need:

  • Community Commons
  • Excel Importer
  • Mx Model Reflection

 

📦 Dependencies (optional)

  • Requires Mendix 10.12.16 or higher

  • Apache POI is embedded and requires no additional setup

 

📥 Installation (optional)

  1. Import the ExportToExcelGeneric.mpk module into your Mendix app

  2. Add the example page or call the Java Action directly from your own microflow

  3. Make sure your entity inherits from System.FileDocument to enable file download

  4. Set access rules to allow create, read, and download on the generated file entity

 

🔧 Configuration (optional)

In your microflow:

  • Create a GeneratedFile object

  • Call the ExportEntityToExcel Java Action, passing:

    • EntityName: full name of the entity as a string (e.g. MyModule.MyEntity)

    • File: the created file object

  • Use a Download file activity to complete the flow

 

🐞 Known Bugs (optional)

  • Entities with a large number of attributes (>100) may slow down Excel generation

  • Enumeration attributes are exported using their keys, not their captions

 

❓ Frequently Asked Questions (optional)

Q: Can I use this with non-persistent entities?A: No, only persistent entities are supported since data is queried using XPath.

Q: Will associated objects or references be exported?A: No, only flat attributes are exported. You can extend the Java logic if needed.

Q: Does it support conditional row or color styling?A: Not in this version. Only header and decimal formatting are applied.

 

 

ESPAÑOL

 

🧩 Escenario típico de uso

Exportar a Excel (Genérico) está diseñado para ayudar a los desarrolladores a exportar cualquier entidad persistente de su aplicación Mendix a un archivo Excel con estilo, usando una única Java Action. Resuelve el problema común de tener que construir manualmente la lógica de exportación, ya que recupera dinámicamente los atributos de la entidad mediante el metamodelo.

Es ideal para:

  • Informes de administración

  • Herramientas internas

  • Exportación de datos para análisis

  • Utilidades para desarrolladores

 

⚙️ Funcionalidades y limitaciones

Funcionalidades:

  • Java Action genérica: no requiere atributos codificados manualmente

  • Lee automáticamente la estructura de la entidad desde el metamodelo

  • Exportación a Excel con estilo, incluyendo:

    • Fila de cabecera en negrita

    • Formato decimal aplicado

    • Columnas con ancho automático

  • Descarga directa del archivo desde el navegador

  • Fácil de integrar en cualquier microflujo

  • Incluye microflujo y página de ejemplo

Limitaciones:

  • Solo funciona con entidades persistentes

  • No exporta atributos de referencias de forma recursiva (estructura plana)

  • El tamaño del archivo puede aumentar con conjuntos de datos grandes (no soporta streaming)

 

📥Necesitas instalar:

  • Community Commons
  • Excel Importer
  • Mx Model Reflection

 

📦 Dependencias (opcional)

  • Requiere Mendix 10.12.16 o superior

  • Apache POI viene embebido y no requiere configuración adicional

 

📥 Instalación (opcional)

  1. Importa el módulo ExportToExcelGeneric.mpk en tu aplicación Mendix

  2. Añade la página de ejemplo o llama directamente a la Java Action desde tu propio microflujo

  3. Asegúrate de que tu entidad hereda de System.FileDocument para permitir la descarga

  4. Configura las reglas de acceso para permitir crear, leer y descargar el archivo generado

 

🔧 Configuración (opcional)

En tu microflujo:

  • Crea un objeto de tipo GeneratedFile

  • Llama a la Java Action ExportEntityToExcel, pasando:

    • EntityName: nombre completo de la entidad como cadena (ej. MiModulo.MiEntidad)

    • File: el objeto de archivo creado

  • Usa una actividad Download file para completar el flujo

 

🐞 Errores conocidos (opcional)

  • Entidades con gran número de atributos (>100) pueden ralentizar la generación del archivo Excel

  • Los atributos de tipo enumeración se exportan con sus claves, no con las etiquetas visibles (captions)

 

❓ Preguntas frecuentes (opcional)

P: ¿Puedo usar esto con entidades no persistentes?R: No, solo se admiten entidades persistentes, ya que los datos se consultan mediante XPath.

P: ¿Se exportan también los objetos asociados o referencias?R: No, solo se exportan los atributos planos. Puedes extender la lógica en Java si lo necesitas.

P: ¿Se pueden aplicar estilos condicionales a las filas o colores?R: No en esta versión. Solo se aplican estilos básicos a la cabecera y a los valores decimales.

Releases

Version: 1.0.2
Framework Version: 10.12.16
Release Notes: Correct Version: change 9.6+ to 10.12.16+
Version: 1.0.1
Framework Version: 9.6.1
Release Notes: - Documentation improvements / Mejoras en la documentación
Version: 1.0.0
Framework Version: 9.6.1
Release Notes: Initial release of Export To Excel (Generic). Includes: - Generic Java Action `ExportEntityToExcel` - Automatic attribute detection via metamodel - Excel export with styled headers and numeric formatting - Microflow and page examples - English and Spanish documentation