Skip to main content
Version: Next

Extraction Models

Introduction​

Extraction Models (or Export Models) allow you to define the structure of an Excel file generated from a list of forms. Unlike standard Excel export which uses the columns from the view, an extraction model enables precise formatting and execution of business rules for each cell.

This is particularly useful for generating complex reports, feeding external dashboards, or exporting data to third-party systems.

Accessing Models​

This functionality is managed in the Forms section of Process Studio:

  1. Open the Forms section.
  2. Click on the Extraction models section (usually in the ribbon or tree view).

Creating a Model​

  1. Click New.
  2. Model name: Give it an explicit name (e.g., "Monthly Accounting Export").
  3. File: Upload an Excel file (.xlsx) that will serve as a "template". This file can contain headers, logos, and pre-configured Excel formulas.
  4. Sheet & Row: Specify in which sheet (e.g., 1) and at which row (e.g., 24) data writing should begin.

Extraction Model Editor

Column Configuration​

The principle is to map each Excel column (A, B, C...) with a calculation rule.

Column Management​

  • Use the + and - buttons to add or remove columns to export.
  • Use the Up/Down arrows to reorganize the processing order (although the column index determines the final position).

Rule Definition​

For each column, you must define:

  1. Column index: The Excel column letter where to write the data (e.g., A, B, AA).
  2. Rule (C#): The script that calculates the value to insert.

The editor provides helpers to quickly insert:

  • Form: To access the document's system properties.
  • Field: To retrieve the value of a specific field.

Rule Examples​

Simple field value:

return doc.GetStringValue("Reference") ?? "";

Formatted date:

DateTime? date = doc.GetDateValue("DateCreation");
if (date.HasValue)
    return date.Value.ToString("dd/MM/yyyy");
return "";

System value (Author):

return doc.GetOwner().DisplayName;

Availability​

The right panel "Make available in browsers" allows you to define where this export model will be offered to users.

  • Check the relevant browsers (views).
  • Users will then see this model in the "Export" menu when they are on these browsers.