General
This article describes the Transaction Object, its purpose, and its properties.
The Transaction Object is the central data container used throughout a transaction. It stores all relevant data, including articles, documents, metadata, and processing state. Its contents are progressively enriched as the transaction moves through its lifecycle.
Structure
class Transaction
{
Id : long
Modes : TransactionModes
Status : TransactionStatus
PrevStatus : TransactionStatus
Result : TransactionResult?
Completed : DateTime?
ConfigurationId : long
Articles : List<Article>
DocumentArticles : List<DocumentArticle>
StructureArticles : List<StructureArticle>
ECOs : List<ECO>
StateChangeArticles : List<StateChangeArticle>
CreatedBy : string
Created : DateTime?
Preparation : bool
Log : List<TransactionLog>
ArticleCount : int
DocumentCount : int
Properties : Dictionary<string, string>
}Properties
Id
Unique database identifier.
Modes
Defines what the transaction contains. See Transaction Modes.
Status
Defines the current state. See Transaction Lifecycle.
PrevStatus
Previous state for rollback and debugging.
Result
Used for statistics tracking.
Completed
Timestamp when the transaction finished.
ConfigurationId
Reference to the configuration used.
Articles
List of unique articles. See Article Object.
DocumentArticles
List of document articles. See Document Article.
StructureArticles
List of structure articles. See Structure Article.
ECOs
List of change orders. See ECO Object.
StateChangeArticles
List of state change entries. See State Change Article.
CreatedBy / Created
Metadata about creation.
Preparation
Indicates if manual review is required.
Log
Transaction logs. See Transaction Log.
ArticleCount / DocumentCount
Aggregated counts.
Properties
Key-value storage for global properties.
Helper Methods
- AddUpdateProperty
- GetProperty
- GetPropertyAsType