universal-export-engine
Service icon

Universal Export Engine

Stable version 1.0.0 (Compatible with OutSystems 11)
Uploaded
 on 31 December 2025
 by 
5.0
 (1 rating)
universal-export-engine

Universal Export Engine

Documentation
1.0.0

📘 Documentation

Overview

Universal Export Engine is an OutSystems Extension that allows exporting any type of data to Excel, PDF, or CSV with full control over layout, formatting, localization, security, and output delivery.


⚙️ Installation

  1. Download the Universal Export Engine from the OutSystems Forge.

  2. Publish the Extension to your environment.

  3. After publishing, the following will be available:

    • Server Actions for export and validation

    • Structures for configuration (Export, Layout, Security, Localization, Output)

  4. No additional environment configuration is required.

✅ The extension is self-contained and does not require manual DLL registration.


🔧 Configuration

All configurations are optional.
If a configuration structure is not provided, the engine automatically applies safe default values.

Available Configuration Areas:

  • Export Options: format, max rows, preview mode

  • Layout Configuration: page size, orientation, column width, alignment

  • Localization Configuration: culture, date format, RTL support

  • Security Configuration (PDF): password, watermark, permissions

  • Performance Configuration: batching, memory optimization

  • Output Configuration: download, email, or storage delivery

You can configure only what you need and leave the rest empty.


▶️ How to Use

Basic Usage

  1. Prepare your data (Record List, Structure, Entity List, or any object).

  2. Call ExportData server action.

  3. Pass:

    • Data

    • Desired export format (Excel / PDF / CSV)

    • Optional configuration structures

  4. Receive:

    • File content (binary)

    • File name

    • Status and validation result


Preview Mode

  • Use PreviewExport to export only a limited number of rows.

  • Useful for testing layout and formatting before full export.


Validation Only

  • Use ValidateExportDefinition to:

    • Check configuration correctness

    • Detect missing or invalid settings

    • Receive warnings and blocking errors

  • No file is generated in this mode.


📦 Supported Data Types

  • Record Lists

  • Entity Lists

  • Structures

  • JSON objects

  • Mixed and nested data

The engine automatically detects columns and data types unless manually overridden.


🧠 Important Notes

  • No assumptions are made about data shape or size

  • Handles nulls, empty datasets, and nested objects safely

  • Designed for large datasets and enterprise use cases

  • Fully reusable across multiple applications