JobPhase Enumeration

Structured Analytics API Documentation
Describes the phase of a structured analytics set analysis.

Namespace:  Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status
Assembly:  Relativity.Threads.Services.Interfaces (in Relativity.Threads.Services.Interfaces.dll) Version: 10.0.0.0 (10.0.0.0)
Syntax

public enum JobPhase
Members

  Member nameValueDescription
Not_Started0 The not started phase indicates the Structured Analytics Set object has been created but analysis of the set or operation has not started.
Setup10 Phase 1 of 7. The setup phase validates the analytics set analysis configuration and prepares documents for ingestion.
SyncingData13 Phase 2 of 7. The syncing data phases is the first step of export and it will sync the data in the analytics engine with the current saved search in order to account for the removal of documents.
CalculatingFileSizes15 Phase 3 of 7. Calculating file sizes is the first step of export that will calculate which documents are allowed to be run through the Analytics Engine.
Exporting20 Phase 4 of 7. The exporting phase exports document text from the workspace database to the Analytics engine.
CompletedExporting25 The completed exporting phase indicates export has finished and running operations is about to begin. Occurs between phase 4 and 5.
RunningOperations30 Phase 5 of 7. The running operations phase monitors the progress of the Analytics engine, while the textual analytics operations are performed.
CompletedOperations35 The completed operations phase indicates that the specified operations have completed and import is about to begin.
ImportingEntityAndAliases38 Phase 6 of 7. This importing phase retrieves entity and alias results from the Analytics engine and imports them into the appropriate locations on the workspace database.
Importing40 Phase 7 of 7. This importing phase retrieves document results from the Analytics engine and imports them into the appropriate locations on the workspace database.
Finalizing45 The finalizing phase indicates that importing of the results has finished and the final result calculations are being generated.
Completed50 The completed phase indicates that the analysis of the structured analytics set is finished. A structured analytics set can be in this phase and contain document level errors.
CompletedWithErrors55 The completed with errors phase indicates that the analysis has finished and document level errors currently exist for the structured analytics set
Error60 The error phase indicates the structured analytics set is currently in an error state.
RetryErrors65 The retry errors phase indicates that the structured analytics set is actively retrying errors.
Canceling70 The canceling phase indicates the most recently run analysis of a structured analytics set is currently being stopped.
Canceled80 The canceled phase indicates that the analysis of the structured analytics set has been canceled and is incomplete.
MissingFields90 The missing fields phase indicates that fields have been deleted and the structured analytics set is in a bad state.
CopyToLegacyInProgress100 The copy to legacy in progress phase indicates that the process of copying result data into the legacy fields on Document is currently running.
CopyToLegacyCancelling110 The copy to legacy cancelling phase indicates that the current copy to legacy process is in the process of cancelling.
PreparingAnalysisInProgress120 The preparing analysis in progress phase indicates that the set is getting everything necessary setup so that an analysis can be run.
PreparingAnalysisCompleted130 The preparing analysis completed phase indicates that everything necessary for an analysis to be run has completed.
PreparingAnalysisError140 The preparing analysis error phase indicates that everything necessary for an analysis to be run has completed.
Unknown-1 The unknown phase indicates that the system is unable to detect the current phase of the analysis.
Remarks

The JobPhase enum is used for general state (Phase) and for the states of individual operations (Phase). Not every phase is valid for both usages - e.g. PreparingAnalysisInProgress is only used in the general state.
See Also

Reference