Data archiving rules for DevOps tables

  • Release version: Washingtondc
  • Updated August 1, 2024
  • 2 minutes to read

    • Base system table archiving rules ensure that DevOps data stored in the Configuration Management Database (CMDB) are systematically archived and purged.

    Archiving rules for DevOps data in CMDB tables

    Data archiving involves managing table size growth and archiving old data. It moves data that is no longer needed every day from primary tables to a set of archive tables. For more information, see Data archiving. Base-system archive rules are configured to auto-archive DevOps tables that are older than a specified period. An archive table is created for any table that has an archive rule associated with it. You can also choose to restore data from archive tables.
    Note:
    While you can restore any record from the archive tables. Once archived data is restored, the same data is no longer auto-archived. For more information, see Manage archived data.
    • Navigate to System Archiving > Archive Rules and select the individual archive rule whose data you restored.
    • Enable the Auto rearchive check box, to resume auto-archiving for that archive rule.

    Modify base system value for archive rules

    You can configure the auto archive duration for all the archive rules that are applicable to DevOps tables from the Auto archive (in months) DevOps system property. By default, this property's value is set to 9 (months). Navigate to DevOps > Administration > Properties > Auto archive (in months), to modify the value. For more information on configuring data archiving, see Create an archive rule

    The following list indicates the tables that are auto-archived.
    Table 1. Auto-archived DevOps tables
    Table Table Name Archived table name
    Artifact Staged Request sn_devops_artifact_staging ar_sn_devops_artifact_staging
    Artifact Version sn_devops_artifact_version ar_sn_devops_artifact_version
    Branch sn_devops_branch ar_sn_devops_branch
    Build Test Result sn_devops_build_test_result ar_sn_devops_build_test_result
    Build Test Summary sn_devops_build_test_summary ar_sn_devops_build_test_summary
    Callback sn_devops_callback ar_sn_devops_callback
    Commit sn_devops_commit ar_sn_devops_commit
    Commit Details sn_devops_commit_details ar_sn_devops_commit_details
    Deployed Artifact to TaskExecution sn_devops_m2m_artifact_execution ar_sn_devops_m2m_artifact_execution
    Artifact Version to Commit sn_devops_m2m_artifact_version_commit ar_sn_devops_m2m_artifact_version_commit
    Branch To Commit sn_devops_m2m_branch_commit ar_sn_devops_m2m_branch_commit
    Run Commit sn_devops_m2m_commit_execution ar_sn_devops_m2m_commit_execution
    Commit To Work Item sn_devops_m2m_commit_work_item ar_sn_devops_m2m_commit_work_item
    Pipeline Execution sn_devops_pipeline_execution ar_sn_devops_pipeline_execution
    Software Quality Scan Summary sn_devops_software_quality_scan_summary ar_sn_devops_software_quality_scan_summary
    Software Quality Scan Summary Relations sn_devops_software_quality_scan_summary_relations ar_sn_devops_software_quality_scan_summary_relations
    Step Execution sn_devops_step_execution ar_sn_devops_step_execution
    Tag sn_devops_tag ar_sn_devops_tag
    Task Execution sn_devops_task_execution ar_sn_devops_task_execution
    Task Summary sn_devops_test_summary ar_sn_devops_test_summary
    Test Summary Relations sn_devops_test_summary_relations ar_sn_devops_test_summary_relations
    Work Item sn_devops_work_item ar_sn_devops_work_item
    The data archiving rules feature considers and honors parent rules before individual archive rules are run. If you have an associated parent archive rule, the child rules are run only when the parent rules are run. Similarly, when you modify individual rules, you must first disable or disassociate the parent archive rule, make the configuration changes, and re-enable the parent archive rule. Changes to the Auto archive (in months) DevOps property overrides any configuration changes made to the duration of child archive rules. For example, you could update the archive rule condition for any of the Active DevOps archive rules to a custom value, say three months instead of the default 9 months. However, if you modify the Auto archive (in months) DevOps property, all modifications made to the conditions of individual archive rules are overwritten by the value in the Auto archive (in months) system property.
    Note:
    The override function is binding for all scenarios except:
    • When an archive rule does not belong to the DevOps scope.
    • When an archive rule belongs to the DevOps scope but is inactive.

    Base system destroy rules for DevOps data

    Base-system destroy rules are also enabled and activated on all the archived DevOps tables. By default, data is deleted from an archived table after 36 months or 1095 days have passed from the time the data is stored in the archive table. For more information, see Create a destroy rule.