User Guides › Matrix Forge

← Previous: Variables Next: Output variables →

Output matrices

Output matrices are row-based grids. Each matrix has a row definition (e.g. how many rows or which range) and columns with formulas evaluated per row. You can have multiple matrices; later matrices can reference earlier ones via Matrix("Name").Rows[RowNum - 1]["ColumnName"].

Row definition

  • The row definition formula determines how many rows the matrix has. Common pattern: Range(1, 50) to create 50 rows (row indices 1–50). The engine sets RowNum to 1, 2, … for each row when evaluating column formulas.
  • Other patterns (e.g. dynamic length from input) are supported when the engine allows.

Columns

  • Each column has a name and a formula. The formula can use:
    • RowNum — Current 1-based row index.
    • PreviousRow["ColumnName"] — Value from the same column (or any column) on the previous row.
    • Col.ColumnName — Value from another column in the current row (order of columns matters: referenced columns should be defined earlier).
    • Input.*, Var.*, Rate(...), DataSheet(...), Matrix("Other").Rows[RowNum - 1]["Col"], etc. See Formula syntax.

Multiple matrices

  • You can define several output matrices (e.g. “ParIllustration”, “CashValues”, “USATaxTestPre”). They run in definition order.
  • To use another matrix in the current row: Matrix("OtherMatrix").Rows[RowNum - 1]["ColumnName"] (0-based index into Rows).
  • You can also use LINQ on Matrix("Name").Rows in formulas (e.g. .Where(...).Sum()) for aggregations across rows.

Include in output (schema)

  • Each matrix has an include in schema (output) toggle. If included, the matrix is written into the Data Schema so downstream steps (forms, layouts, reports) can bind to it.
  • Each column within a matrix can also be included or excluded independently. So you can expose only some columns to the schema.
  • Default is typically: matrix and all columns included. Uncheck the matrix to exclude the whole grid; uncheck individual columns to hide them from the schema while keeping them for internal formulas (e.g. in output variables).
  • If you exclude a matrix but leave some columns checked, the UI may prompt you to include the matrix or to clear column inclusion.

User Guides › Matrix Forge

← Previous: Variables Next: Output variables →