Skip to content

Commit aa646b1

Browse files
authored
Update DIRECT_Functional_Design.md
1 parent 54d77af commit aa646b1

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

000_Documentation/DIRECT_Functional_Design.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -210,21 +210,21 @@ These checks are:
210210

211211
### Execution Status Code
212212

213-
Of the three code fields, the execution status summarizes the (Module / Batch) Instance's processing and as such is the main operational indicator. Although there are exceptions, in most cases the status of an Instance will always be either Executing, Failed, or Succeeded. The Execution Status Code is completely driven by the process framework subsystem and should not be altered ('read only').
213+
Of the three code fields, the execution status summarizes the (Module / Batch) Instance's processing and as such is the main operational indicator. Although there are exceptions, in most cases the status of an Instance will always be either Executing, Failed, or Succeeded. The Execution Status Code is completely driven by the process framework subsystem and should not be altered.
214214

215-
After proper testing and deployment all runs should complete successfully (Execution Status Code equals `S`). An overview of severity is shown in the following diagram:
215+
After proper testing and deployment all runs should complete successfully (Execution Status Code equals `Success`). An overview of severity is shown in the following diagram:
216216

217217
<img src="./Images/Direct_Documentation_Figure9.png" alt="Figure 2" width="100%">
218218

219219
The detailed code purpose is defined in the following table
220220

221-
| Code | Value | Description |
222-
| ---- | --------- | ------------------------------------------------------------ |
223-
| E | Executing | The ETL instance is currently running (executing). This is only visible while the ETL process is actually running. As soon as it is completed this code is updated with one of the possible values below. |
224-
| S | Succeeded | The instance is no longer running after successful completion of the process. |
225-
| F | Failed | The instance is no longer running after completed with failures. |
226-
| A | Aborted | An abort is an attempted execution which led to the instance unable to start. Abort means that the process did not run, but was supposed to. This is typically the result of incorrect configuration or race conditions in the orchestration. The most common reasons for an abort in the ETL execution are:<br /><br />There is already another instance of the same Batch or Module running. The same logical unit of processing can never run more than once at the same time to maintain data consistency. If this situation is detected the second process will abort before any data is processed.<br /><br />The Module (Instance) was executed from a parent Batch (Instance) but not registered as such in the Batch/Module relationship. |
227-
| C | Cancelled | The cancelled (skipped) status code indicates that the instance was attempted to be executed, but that the process control framework found that it was not necessary to run the process. <br /><br />This can be due to Modules or Batches being disabled in the framework using the 'inactive indicator'. Disabling processes can be done at Batch, Batch/Module and Module level.<br /><br />Another common scenario is that, when Batch (workflows) are restarted, earlier successful Modules in that Batch will not be reprocessed. These Module Instances will be skipped / cancelled until the full Batch has completed successfully. This is to guarantee completeness in data (prevention of data loss). |
221+
| Code | Description |
222+
| ---- | ------------------------------------------------------------ |
223+
| Executing | The instance is currently running (executing). This is only visible while the process is actually running. As soon as it is completed this code will be updated to one of the end-state execution codes. |
224+
| Success | The instance is no longer running after successful completion of the process. |
225+
| Failed | The instance is no longer running after completing with failures. |
226+
| Aborted | An abort is an attempted execution which led to the instance unable to start. Abort means that the process did not run, but was supposed to. This is typically the result of incorrect configuration or race conditions in the orchestration. The most common reasons for an abort is that another instance of the same Batch or Module is already running. The same logical unit of processing can never run more than once at the same time to maintain data consistency. If this situation is detected the second process will abort before any data is processed.<br /><br />The Module (Instance) was executed from a parent Batch (Instance) but not registered as such in the Batch/Module relationship. |
227+
| Cancelled | The cancelled (skipped) status code indicates that the instance was attempted to be executed, but that the control framework found that it was not necessary to run the process. <br /><br />This can be due to Modules or Batches being disabled in the framework using the 'active indicator'. Disabling processes can be done at Batch, Batch/Module and Module level.<br /><br />Another common scenario is that, when Batches are restarted, earlier successful Modules in that Batch will not be reprocessed. These Module Instances will be skipped / cancelled until the full Batch has completed successfully. This is to prevents data loss. |
228228

229229
### Processing Indicator
230230

0 commit comments

Comments
 (0)