A new functionality was introduced in Origam 2025.5 that allows for the documentation of database fields. This feature is available in the system package named Documentation, and it provides detailed descriptions of database-mapped fields and their attributes.
Attributes
| Attribute | Description |
|---|---|
| Package | Name of the package containing the field |
| Entity | Database-mapped table name of the entity containing the field |
| Field Name | Database-mapped column name of the field |
| Caption | Display caption of the field as used in screens |
| Allow Nulls | Indicates whether the field allows null values |
| Data Type | Data type of the field (e.g., string, integer) |
| Data Length | Length of the data (relevant for string data types) |
| Default Value | Default value assigned to the field |
| Is Primary Key | Indicates whether the field is defined as a primary key |
| Foreign Key Entity | Database-mapped table name of the referenced foreign key entity |
| Foreign Key Field | Database-mapped column name of the referenced foreign key field |
| User Short Help | Linked documentation element of type User Short Help |
| User Long Help | Linked documentation element of type User Long Help |
These attributes are automatically generated from metadata defined in the entity’s XML file using the ModelService method GetDatabaseFieldsMetaData.
The result is a list of documented fields displayed in the Database Field Description screen under Settings > Documentation.
A detailed description how to implement this feature in existing projects can be found here.