Database schema updates

The table below lists the updates made in recent releases to both the EDDS and Workspaces database schema.

Note: Changes marked as Continuous improvement in the Version column below were deployed outside of a planned release.

Database schema updates table

Database Table affected Change type Change details Version
Workspace ProductionDataSource Modification The following columns are new:
  • NativeRedactTextField (a single object type)
  • BurnNativeRedactions (a boolean type field)
 White Sedge 2/13.1
EDDS ProductionSetQueue Modification The following columns are new and are in place to track the progress of a production set:
  • NativeBrandingQueueRecordsCount
  • NativesWithErrors
  • NativesRemaining
  • TotalNatives
 Yarrow 0/13.2
EDDS AnalyticsIndexC4PopulationJob Modification The JobLockExpire column is new, and it stores a datetime value to move away from agent processor locks to time out locks. This change was made to support the transition of RelativityOne Analytics Index Population Manager agents to k8s. Tiger Lily 0/13.0
Workspace AnalyticsIndexMetadataRepository Modification The IngestionJobID column is new and it stores the ID of the Analytics index job. Sundrop/12.3
EDDS CustomPage Modification The IsStaticBasedContent column is new on the CustomPage table and was added to monitor the type of the CustomPages Sundrop/12.3
EDDS ApplicationToggle Addition The ApplicationToggle table is new and stores a list of toggles used by an ADS application. Prairie Smoke/12.2
EDDS
  • AnalyticsCoreWorkspaceMigrationManagerQueue
  • AnalyticsCoreManagerMigrationManagerQueue
 Modification The AgentName column has been removed. The JobLockExpire column is new and stores an indicator that the Analytics Core ARM agents are working on a job. When the job is isn't being worked on, this value is null. Prairie Smoke/12.2
Workspace AnalyticsIndexMetadata Modification The ActivationInProgress column is new and it stores an indicator of whether index activation is in progress. A value of 1 indicates activation is in progress. A value of 0 indicates activation is not in progress. Prairie Smoke/12.2
EDDS ProductionSetQueue Modification The following columns are new and are used to resume the staging process when a production staging is paused for RAP deploy in RelativityOne:
  • LastProductionInfoRecord stores the last production information record that was created in the staging process
  • StagingBatchSize stores the batch size for creating production information objects.
 Prairie Smoke/12.2
EDDS ApplicationComponent Addition The ApplicationComponent table is new and it maintains a record of all guids associated with Library Applications within the instance. Prairie Smoke/12.2
Workspace ActiveLearningReview Modification The following columns are new:
  • IncludeRecall
  • ElusionRate
  • EludedDocuments
  • Precision
  • PrecisionMarginofError
  • Recall
  • RecallLower
  • RecallUpper
  • Richness
  • RichnessMarginofError
    ElusionRate and EludedDocuments are used to store Elusion Test statistics for an accepted or rejected Elusion Test so they do not need to be recalculated.
    All other columns are used to store new statistics for an Elusion Test that were not previously displayed at all (users will need to opt in at the time of starting an Elusion Test, because this involves changes to how we sample documents)
 Osier/12.1
Workspace Document Modification Any missing relational indexes are recreated during the database upgrade phase. Osier/12.1
EDDS ToggleDefault Addition The ToggleDefault table is new and it stores toggle default values. Osier/12.1
EDDS Toggle Modification The Default column has been removed, and the IsEnabled column no longer allows null values. Osier/12.1
EDDS
  • OCRSetQueue
  • OCRWorkerQueue
 Removal As part of Relativity's OCR decoupling, we have removed the following two tables from EDDS database:
  • OCRHistory
  • OCRSetQueue
  • OCRWorkerQueue
  • SystemArtifact
 Osier/12.1
EDDS PdfMaintenance Addition This new table is a component of the new PDF application. Ninebark/12.0
EDDS AnalyticsIndexMetadata Modification The new field LastJobStageFinished in AnalyticsIndexMetadata keeps track of the last time a conceptual analytics index finished a build-related (population, build, activation, errored) process. This is similar to the existing field LastUsedOn which timestamps the same times as LastJobStageFinished but also includes times that the index was used for queries. Ninebark/12.0
EDDS/Workspace ScriptRun Modification The ScriptLastModified and AgentCheckInDatetime columns have been changed from type datetime2 to type datetime. Osier/12.1
EDDS Toggles Modification The IsEnabled column now allows nulls. Osier/12.1
Workspace DgImportFileInfoType Addition It's required for table valued parameters to move large number of rows in one call and to avoid a huge IN clause. Osier/12.1
Workspace AnalyticsCategorizationSetMetadata Modification The Analytics Core application post install event handler adds the KeepRemovedResults BIT NOT NULL column to the AnalyticsCategorizationSetMetadata table. This column acts as a per categorization set level switch to enable or disable functionality used by the Trace application. Ninebark/12.0
Workspace ImageQueueDataAccess Addition The ImageQueueDataAccess table is new and is created in the middle of an image-to-PDF job in your workspace. The table name structure is this: PDF_ID_JOBGUID (e.g. PDF_96_IMAGE_71d9aa6bd7a34504aa7e5b8a2a48d399) Ninebark/12.0
EDDS N/A Modification A new job type has been introduced for processing. Job type name is FinalizeJobPublishWithExpression jobtype. This job type is entered as a system artifact. Osier/12.1
EDDS AgentType Modification Removed the OCR Set Manager and OCR Worker agent types from Relativity. They were replaced with new OCR Agents. Osier/12.1
EDDS AccessControlListPermission Modification With this change, custom page permissions have been removed from the Everyone group. Ninebark/12.0
EDDS AnalyticsIndexC4PopulationJob Modification There is a new column called JobID, and it stores population job IDs for reporting purposes. Ninebark/12.0
Workspace PDFjob Modification There is a new column called Rotation for saving image rotation settings while generating PDFs from images. The PDFjob table is dynamically generated to hold the references to images for PDF jobs. Mayapple/11.3
EDDS AgentType Modification There is a new column on the AgentType table called SharedCompute. Ninebark/12.0
EDDS PDFjob Modification The AuditArtifactID column lists the actual user getting audited instead of the preview user. This is the result of a defect fix. Lanceleaf/11.2
Workspace AutomatedWorkflowEvents Addition The new table AutomatedWorkflowEvents is created at the workspace level where the Relativity Automated Workflows application in installed, to account for changes in the workflow and action-level status. For this reason, few events will be created, and fired when status updates are received for the workflow and/or action within a workflow. This way, the front end can display status projections to Automated Workflow users. Lanceleaf/11.2 (Update 1)
Workspace ContainerArtifactAncestry Removal We've removed legacy ContainerArtifactAncestry table and replaced it with references to ContainerArtifact in ExtendedFolder. We've also removed the following unused triggers:
  • FolderDelete
  • FolderInsert
  • SearchContainerDelete SearchContainerInsert
Osier EA
EDDS ApplicationInstall Modification There are two new columns on the ApplicationInstall table to track cases in which an application install fails.
  • ExceptionCategory - the root cause of a particular failure.
  • FailedTask - the step where the failure occurred.
 Ninebark/12.0
EDDS LoginMethod Modification There are two new columns on LoginMethod table:
  • AuthenticatorSecretID - refers to the user's TFA authenticator seed key in secre store
  • AuthenticatorSecretValidated - tracks if the user has used the authenticator login at least once
 Ninebark/12.0
EDDS AuthenticatorCodeHistory Addition The new table AuthenticatorCodeHistory keeps a subset history of previous one-time-use passcodes used at login. This is to prevent a user from using a single code multiple times in a short period of time. Ninebark/12.0
Workspace
  • RelativityAutomatedWorkflowsTriggers
  • RelativityAutomatedWorkflowsActions
 Addition There is a new Version column on each of the following tables:
  • RelativityAutomatedWorkflowsTriggers
  • RelativityAutomatedWorkflowsActions
 Lanceleaf/11.2 (Update 1)
EDDS PdfJob Addition We've added an index to the PDF application's job table. Juniper/11.1 (Update 2)
Workspace ProductionDataSource Modification The following columns are new:
  • NativeRedactTextField (a single object type)
  • BurnNativeRedactions (a boolean type field)
 White Sedge 2/13.1
EDDS ProductionSetQueue Modification The following columns are new and are in place to track the progress of a production set:
  • NativeBrandingQueueRecordsCount
  • NativesWithErrors
  • NativesRemaining
  • TotalNatives
 Yarrow 0/13.2
EDDS AnalyticsIndexC4PopulationJob Modification The JobLockExpire column is new, and it stores a datetime value to move away from agent processor locks to time out locks. This change was made to support the transition of RelativityOne Analytics Index Population Manager agents to k8s. Tiger Lily 0/13.0
Workspace AnalyticsIndexMetadataRepository Modification The IngestionJobID column is new and it stores the ID of the Analytics index job. Sundrop/12.3
EDDS CustomPage Modification The IsStaticBasedContent column is new on the CustomPage table and was added to monitor the type of the CustomPages Sundrop/12.3
EDDS ApplicationToggle Addition The ApplicationToggle table is new and stores a list of toggles used by an ADS application. Prairie Smoke/12.2
EDDS
  • AnalyticsCoreWorkspaceMigrationManagerQueue
  • AnalyticsCoreManagerMigrationManagerQueue
 Modification The AgentName column has been removed. The JobLockExpire column is new and stores an indicator that the Analytics Core ARM agents are working on a job. When the job is isn't being worked on, this value is null. Prairie Smoke/12.2
Workspace AnalyticsIndexMetadata Modification The ActivationInProgress column is new and it stores an indicator of whether index activation is in progress. A value of 1 indicates activation is in progress. A value of 0 indicates activation is not in progress. Prairie Smoke/12.2
EDDS ProductionSetQueue Modification The following columns are new and are used to resume the staging process when a production staging is paused for RAP deploy in RelativityOne:
  • LastProductionInfoRecord stores the last production information record that was created in the staging process
  • StagingBatchSize stores the batch size for creating production information objects.
 Prairie Smoke/12.2
EDDS ApplicationComponent Addition The ApplicationComponent table is new and it maintains a record of all guids associated with Library Applications within the instance. Prairie Smoke/12.2
Workspace ActiveLearningReview Modification The following columns are new:
  • IncludeRecall
  • ElusionRate
  • EludedDocuments
  • Precision
  • PrecisionMarginofError
  • Recall
  • RecallLower
  • RecallUpper
  • Richness
  • RichnessMarginofError
    ElusionRate and EludedDocuments are used to store Elusion Test statistics for an accepted or rejected Elusion Test so they do not need to be recalculated.
    All other columns are used to store new statistics for an Elusion Test that were not previously displayed at all (users will need to opt in at the time of starting an Elusion Test, because this involves changes to how we sample documents)
 Osier/12.1
Workspace Document Modification Any missing relational indexes are recreated during the database upgrade phase. Osier/12.1
EDDS ToggleDefault Addition The ToggleDefault table is new and it stores toggle default values. Osier/12.1
EDDS Toggle Modification The Default column has been removed, and the IsEnabled column no longer allows null values. Osier/12.1
EDDS
  • OCRSetQueue
  • OCRWorkerQueue
 Removal As part of Relativity's OCR decoupling, we have removed the following two tables from EDDS database:
  • OCRHistory
  • OCRSetQueue
  • OCRWorkerQueue
  • SystemArtifact
 Osier/12.1
EDDS PdfMaintenance Addition This new table is a component of the new PDF application. Ninebark/12.0
EDDS AnalyticsIndexMetadata Modification The new field LastJobStageFinished in AnalyticsIndexMetadata keeps track of the last time a conceptual analytics index finished a build-related (population, build, activation, errored) process. This is similar to the existing field LastUsedOn which timestamps the same times as LastJobStageFinished but also includes times that the index was used for queries. Ninebark/12.0
EDDS/Workspace ScriptRun Modification The ScriptLastModified and AgentCheckInDatetime columns have been changed from type datetime2 to type datetime. Osier/12.1
EDDS Toggles Modification The IsEnabled column now allows nulls. Osier/12.1
Workspace DgImportFileInfoType Addition It's required for table valued parameters to move large number of rows in one call and to avoid a huge IN clause. Osier/12.1
Workspace AnalyticsCategorizationSetMetadata Modification The Analytics Core application post install event handler adds the KeepRemovedResults BIT NOT NULL column to the AnalyticsCategorizationSetMetadata table. This column acts as a per categorization set level switch to enable or disable functionality used by the Trace application. Ninebark/12.0
Workspace ImageQueueDataAccess Addition The ImageQueueDataAccess table is new and is created in the middle of an image-to-PDF job in your workspace. The table name structure is this: PDF_ID_JOBGUID (e.g. PDF_96_IMAGE_71d9aa6bd7a34504aa7e5b8a2a48d399) Ninebark/12.0
EDDS N/A Modification A new job type has been introduced for processing. Job type name is FinalizeJobPublishWithExpression jobtype. This job type is entered as a system artifact. Osier/12.1
EDDS AgentType Modification Removed the OCR Set Manager and OCR Worker agent types from Relativity. They were replaced with new OCR Agents. Osier/12.1
EDDS AccessControlListPermission Modification With this change, custom page permissions have been removed from the Everyone group. Ninebark/12.0
EDDS AnalyticsIndexC4PopulationJob Modification There is a new column called JobID, and it stores population job IDs for reporting purposes. Ninebark/12.0
Workspace PDFjob Modification There is a new column called Rotation for saving image rotation settings while generating PDFs from images. The PDFjob table is dynamically generated to hold the references to images for PDF jobs. Mayapple/11.3
EDDS AgentType Modification There is a new column on the AgentType table called SharedCompute. Ninebark/12.0
EDDS PDFjob Modification The AuditArtifactID column lists the actual user getting audited instead of the preview user. This is the result of a defect fix. Lanceleaf/11.2
Workspace AutomatedWorkflowEvents Addition The new table AutomatedWorkflowEvents is created at the workspace level where the Relativity Automated Workflows application in installed, to account for changes in the workflow and action-level status. For this reason, few events will be created, and fired when status updates are received for the workflow and/or action within a workflow. This way, the front end can display status projections to Automated Workflow users. Lanceleaf/11.2 (Update 1)
Workspace ContainerArtifactAncestry Removal We've removed legacy ContainerArtifactAncestry table and replaced it with references to ContainerArtifact in ExtendedFolder. We've also removed the following unused triggers:
  • FolderDelete
  • FolderInsert
  • SearchContainerDelete SearchContainerInsert
 Osier EA
EDDS ApplicationInstall Modification There are two new columns on the ApplicationInstall table to track cases in which an application install fails.
  • ExceptionCategory - the root cause of a particular failure. FailedTask - the step where the failure occurred.
 Ninebark/12.0
EDDS LoginMethod Modification There are two new columns on LoginMethod table:
  • AuthenticatorSecretID - refers to the user's TFA authenticator seed key in secre store
  • AuthenticatorSecretValidated - tracks if the user has used the authenticator login at least once
 Ninebark/12.0
EDDS AuthenticatorCodeHistory Addition The new table AuthenticatorCodeHistory keeps a subset history of previous one-time-use passcodes used at login. This is to prevent a user from using a single code multiple times in a short period of time. Ninebark/12.0
Workspace
  • RelativityAutomatedWorkflowsTriggers
  • RelativityAutomatedWorkflowsActions
 Addition There is a new Version column on each of the following tables:
  • RelativityAutomatedWorkflowsTriggers
  • RelativityAutomatedWorkflowsActions
 Lanceleaf/11.2 (Update 1)
EDDS PdfJob Addition We've added an index to the PDF application's job table. Juniper/11.1 (Update 2)