DOCSP-30586 Data Verification Drawer (#9)

* DOCSP-30586 Data Verification Drawer

Author: ianf-mongodb

source/jobs/creating-jobs.txt

@@ -1,3 +1,5 @@
+.. _rm-create-jobs:
+
 =================
 Create a Sync Job
 =================

source/jobs/data-verification/data-verification.txt

@@ -4,6 +4,38 @@
 Data Verification
 =================
 
+Data verification is a process that is built into the sync engine.
+The data verification process uses the source and destination 
+connection strings to validate that a sync job was successful.
+
+- Data verification is supported for one-time sync jobs.
+- By default, data verification is not performed when running a sync job. 
+  You must explicitly opt-in to verification in :guilabel:`Migration Options` 
+  before the job is started.
+- Enabling data verification can add significant compute time to a sync 
+  job.
+
+When data verification is successful, source and destination states match.
+
+- The source relational database row count equals the target collection 
+  document count.
+- The source relation rows are equivalent to the collection documents.
+
+When data verification is unsuccessful, source and destination states 
+do not match.
+
+Data verification does not consider the following when verifying 
+destination databases:
+
+- The destination collection contained unrelated data before the sync 
+  job started.
+- The data in the relational database tables has changed since the sync 
+  job was started.
+
+Learn More
+----------
+
+:ref:`rm-use-data-verification`
 
 .. toctree::
    :titlesonly:

source/jobs/data-verification/use-data-verification.txt

@@ -1,3 +1,112 @@
+.. _rm-use-data-verification:
+
 =====================
 Use Data Verification
-=====================
+=====================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Data verification runs as a separate process that is tightly
+coupled to a sync job. Data verification can be enabled for one-time 
+sync jobs. This page details how to enable and debug the 
+data verification process.
+
+Enable Data Verification
+------------------------
+
+You can enable data verification when :ref:`creating a sync job <rm-create-jobs>`
+on the :guilabel:`Data Migration` tab.
+
+On the :guilabel:`Migration Options` module, click the 
+:guilabel:`Verify migrated data` check box for your sync job.
+
+.. note:: Data Verification Duration
+
+   The Data Verification process can take as long or longer than the data sync job.
+   You can click :guilabel:`Terminate` to cancel a Data Verification process.
+
+To view status and metadata information about the data verification process
+for a sync job, click the :guilabel:`SYNC JOB / DATA VERIFICATION` slider.
+
+.. image:: /img/jobs/data-verification/data-verification-click-slider.png
+   :alt: Click Data Verification Slider
+
+Data Verification Overview
+--------------------------
+
+On the :guilabel:`Data Verification` pane, you can view the metadata 
+about a sync jobs verification process.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Syntax
+     - Description
+   * - Verification Status
+     - The state of the verification process.
+   * - Started
+     - The date time stamp that data verification process started.
+   * - Duration
+     - The total elapsed time of the data verification process.
+   * - Collections verified
+     - The total number of collections verified by the data verification process.
+   * - Documents verified
+     - The total number of documents verified by the data verification process.
+   * - Verification progress
+     - A real time percentage indicator of total work completed by the data verification process.
+
+
+Data Verification Statuses
+--------------------------
+
+A data verification process can be any of the following statuses:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 80
+
+   * - Status
+     - Description
+   * - ABORTED
+     - A running data validation was unable to complete due to an error.
+   * - CANCELLED
+     - The data validation process was cancelled by clicking :guilabel:`TERMINATE`.
+   * - CANCELLING
+     - The data validation process is being canceled.
+   * - FAILED
+     - The source and destination databases do not match. The corresponding errors are listed on the :guilabel:`Issues` pane.
+   * - VERIFIED
+     - Data validation is successful, the source and destination databases match.
+   * - VERIFYING
+     - The data validation is in progress. Backend SQL and MongoDB query API commands are running to validate the migration.
+
+Successful Data Verification
+----------------------------
+
+When a sync job is successful the status updates to :guilabel:`VERIFIED`
+and a double checkmark is displayed in the :guilabel:`History` pane.
+
+.. image:: /img/jobs/data-verification/data-verification-double-checkmark.png
+   :alt: History pane double checkmark
+   
+
+Data Verification Issues
+------------------------
+
+If the data verification process detects any differences between the 
+source database and destination collections, the errors are
+reported in the Data Verification :guilabel:`Issues` pane.
+
+In this example, the data verification process is detecting that the
+number of documents in the target collection do not match the source
+database.
+
+#. The Verification status is :guilabel:`FAILED`.
+#. The specific issue and error detail is displayed in the :guilabel:`Issues` pane.
+
+.. image:: /img/jobs/data-verification/data-verification-view-issues.png
+   :alt: Data verification issues