One run of an integration pipeline, recording whether it succeeded and every message logged while it ran. A run is keyed on the pipeline path plus an execution id derived during processing that identifies this particular run, for example the date range of an imported file or the filename itself. Because the pair can be looked up before starting, it is what stops the same file being processed twice when it is sent again by accident, and the file hash column supports the same check on content rather than name. Progress is tracked through the status constants on this class, from preparing to started to either error or complete, and the warning, failure and information messages are each held as newline separated text. Deletion is soft, by stamping deletedBy and deletedDate, and the finders on this class skip deleted runs.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| deletedBy | Profile | The profile that soft deleted the run. Its presence is what marks the run deleted, and the finders on this class skip any run that has it set. |
| deletedDate | Date | When the run was soft deleted. |
| destination | String | Where the data was sent on an outbound run, being the destination URL or email address. |
| endDate | Date | When processing finished. Still null on a run that is in progress, or on one that died without completing. |
| executionId | String | Identifies this particular run within its pipeline, for example the imported filename or the date range the run covers. Looking up the pipeline path and this value together is how repeated processing of the same input is detected, so it is not unique by itself. |
| failures | String | Failure messages logged during the run, one per line. These are the records or steps that did not succeed, and normally accompany the error status. |
| fileHash | String | The hash of the uploaded file this run processed, so identical content can be recognised even when it arrives under a different name. |
| fromDate | Date | The start of the period the run selected records from. This is about the data being moved, not about when the run happened. |
| id | long | Database identifier for this run. |
| infos | String | Information messages logged during the run, one per line, giving the running commentary on what was processed. |
| pipelinePath | String | The path of the pipeline that was run. Together with the execution id this identifies a run. |
| source | String | Where the data came from on an inbound run, being the source IP address or email address. |
| startDate | Date | When processing started. Runs are listed newest first on this date. |
| status | String | Where the run got to, as one of the single character status constants on this class: preparing, started, error or complete. |
| toDate | Date | The end of the period the run selected records from. This is about the data being moved, not about when the run happened. |
| warnings | String | Warning messages logged during the run, one per line. Warnings do not stop the run, so a completed run can still have them and they are worth showing to whoever is watching the integration. |
| websiteBranch | Branch | The website branch the pipeline definition was loaded from, so a run can be traced back to the version of the pipeline that produced it. |
Methods
getId() · getWebsiteBranch() · getExecutionId() · getFileHash() · getPipelinePath() · getStartDate() · getEndDate() · getFromDate() · getToDate() · getWarnings() · getFailures() · getInfos() · getSource() · getDestination() · getStatus() · getDeletedBy() · getDeletedDate()
getId()
Returns: long
Database identifier for this run.
getWebsiteBranch()
Returns: Branch
The website branch the pipeline definition was loaded from, so a run can be traced back to the version of the pipeline that produced it.
getExecutionId()
Returns: String
Identifies this particular run within its pipeline, for example the imported filename or the date range the run covers. Looking up the pipeline path and this value together is how repeated processing of the same input is detected, so it is not unique by itself.
getFileHash()
Returns: String
The hash of the uploaded file this run processed, so identical content can be recognised even when it arrives under a different name.
getPipelinePath()
Returns: String
The path of the pipeline that was run. Together with the execution id this identifies a run.
getStartDate()
Returns: Date
When processing started. Runs are listed newest first on this date.
getEndDate()
Returns: Date
When processing finished. Still null on a run that is in progress, or on one that died without completing.
getFromDate()
Returns: Date
The start of the period the run selected records from. This is about the data being moved, not about when the run happened.
getToDate()
Returns: Date
The end of the period the run selected records from. This is about the data being moved, not about when the run happened.
getWarnings()
Returns: String
Warning messages logged during the run, one per line. Warnings do not stop the run, so a completed run can still have them and they are worth showing to whoever is watching the integration.
getFailures()
Returns: String
Failure messages logged during the run, one per line. These are the records or steps that did not succeed, and normally accompany the error status.
getInfos()
Returns: String
Information messages logged during the run, one per line, giving the running commentary on what was processed.
getSource()
Returns: String
Where the data came from on an inbound run, being the source IP address or email address.
getDestination()
Returns: String
Where the data was sent on an outbound run, being the destination URL or email address.
getStatus()
Returns: String
Where the run got to, as one of the single character status constants on this class: preparing, started, error or complete.
getDeletedBy()
Returns: Profile
The profile that soft deleted the run. Its presence is what marks the run deleted, and the finders on this class skip any run that has it set.
getDeletedDate()
Returns: Date
When the run was soft deleted.