Job Validation Report Using REST API
Learn how to review the migration job validation report using the DryvIQ REST API.
Table of Contents
Overview
Control the level of tracking and reporting for content that exists on both the source and destination platforms, including content that has been configured to be excluded from transfer and content that existed on the destination before the initial transfer. This feature categorizes items for reports on the Validation tab or within the job transfer block using the "item_inspection_policy"." Items that have been ignored/skipped by a policy or not shown because they already exist on the destination can now be seen in reports with the defined categories.
All job types and transfer directions support validation:
- Basic transfer, Folder mapping, User job mapping, Network home drive mapping
- Simulation Mode (Analyzer)
- Transfer in one direction with copy and both directions with sync
- Jobs using Impersonation (Run as user).
Only the Content Reconciliation is available on the Validation report for roll-up reports.
"item_inspection_policy": "none" (Default)
The default validation option is inspect “none.” This option does not need to be configured in the application user interface or through the REST API; it is the system default. This configuration will not track all items, but it will offer additional tracking with performance in mind. Inspect none will track all items on the source at all levels of the hierarchy, but will not include items configured to be ignored/skipped through a policy. For the destination, all content in the root (files and folders) that existed before the initial transfer will be tracked as destination-only items and reported as ignored/skipped.
This option has the following features:
- This option does not need to be configured in the application user interface or through the REST API; it is the system default.
- Jobs created in previous releases will now assume this setting after the upgrade. A soft reset will be required to align the validation chart calculations using the inspect none configuration.
- Source: All content (files and folders) at all levels in the hierarchy will be tracked; items configured to be ignored/skipped through a policy will not be tracked. If the connection does not have access to a given folder in the hierarchy, DryvIQ cannot track and report the items.
- Destination: All content in the root (files and folders) that existed before the initial transfer will be tracked as destination-only items and reported as ignored/skipped. All content in the lower depths of the directory (subfolders) that existed before the initial transfer will not be tracked.
- If the connection does not have access to a given folder in the hierarchy, DryvIQ cannot track and report the items.
- Job type Sync: The destination will behave like the source.
- Job Reports - Validation tab: At any time, you can run a validation run, which triggers a full inspection of all content related to the option you select for the next run only.
JSON Configuration
"transfer": {
"item_inspection_policy": "none",
"item_inspection_policy_next": "none"
}
"item_inspection_policy": "all" (Track Everything)
The “all” validation option tracks all content at all levels in the hierarchy on both the source and destination, including items configured to be ignored/skipped through a policy and items that existed on the destination before the initial transfer.
This option has the following features:
- This option can be configured using the REST API or through the Advanced Scripting JSON block in the application user interface.
- Source: All content in the root, folder, and subfolder directories, including those configured to be skipped/ignored through a policy and items that existed on the destination before the initial transfer will be tracked.
- Destination: All content in the root, folder, and subfolder directories, including those configured to be skipped/ignored through a policy and items that existed on the destination before the initial transfer will be tracked.
- If the connection does not have access to a given folder in the hierarchy, DryvIQ cannot track and report these items.
JSON Configuration
"transfer": {
"item_inspection_policy": "all",
"item_inspection_policy_next": "all"
}
Content Reconciliation
The content reconciliation provides a comparison of the reconciled items between the source and destination. It can help track the success of the migration. By default, it shows counts for files and folders, but you can choose to view only folders, only files, or data. It reports on the following information:
- Identified: This is the total count of items or data identified on the source and destination (including flagged/retried items).
- Ignored destination-only items: This is the number of items ignored on the destination and the percentage of the overall content that these items make up.
- Ignored [Filter]: If filters were added to the job to exclude content, any entry for each filter is included in this section. It will identify the count of the filtered items and the percentage of the overall content that these items make up.
- Successfully matched or transferred (Including flagged and revised): This is the count of items or data that have been successfully matched or transferred between the course and destination.
Transfer Stats, By Inspection
GET {{url}}v1/transfers/{{job_id}}/stats/by_inspection
Validation Reset Options Through the REST API
inspect_filtered
This job reset will reevaluate all filtered content on both the source and destination in the next job run after the reset is executed, including content that was ignored due to a policy configured for job filters, hidden content, and content shared with the transfer owner.
PATCH {{url}}v1/jobs/{{job}}?reset=inspect_filtered
inspect_shared
This job reset will reevaluate all shared content on both the source and destination in the next job run after the reset is executed, including content that was ignored due to a policy configured to exclude data not owned by the transfer author/owner.
PATCH {{url}}v1/jobs/{{job}}?reset=inspect_shared
inspect_all
This job reset will reevaluate all content on the source and destination in the next job run after the reset is executed, including content that was ignored due to a policy configured for filters and shared items.
PATCH {{url}}v1/jobs/{{job}}?reset=inspect_all
Reset Configurations UI Alignment
Configuration | Behavior |
---|---|
Validation: Track Everything
|
Produce the same results as inspect_all.
|
Validation tab in the UI when both of these options are checked
|
Makes the same call as inspect_all.
|
Validation tab in the UI when this item is checked
|
Makes the same call as inspect_filtered.
|
Validation tab in the UI when this item is checked
|
Makes the same call as inspect_shared.
|
Export Items Report in the User Interface
In the DryvIQ Platform, the exported items report will have a status column where skipped content will be recorded. For each skipped entry, observe the value for the source_exists and destination_exists columns.
- source_exists = true: This means DryvIQ has identified the skipped item
- destination_exists = false: This means DryvIQ has identified but did not transfer the item