Content Scans
- Andrea Harvey
On This Page
Overview
The Content Scans page provides an overview of the scans added to the DryvIQ Platform. The Scan name column displays the name assigned to the scan when it was created and lists the scan types selected. The Connection column identifies the platform, connection, and account used to access the platform. The Path column identifies the location selected for the scan (the target directory). The Scan status column identifies the information for when the scan last ran.
Viewing Child Scans
Only primary scans display on the All Scans page. When adding a content scan, you can use a document set or make the location a mapped location. In both instances, all scanning takes place at the child level rather than at the primary scan level. The primary scan runs only to determine the child scans that need to be created. For mapped locations, a child scan is created for each folder that is one level under the path selected for the scan. For document sets, a child scan is created for each path saved in the document set.
Mapped locations are identified by a folder icon in front of the path and “Mapped location” under the path. Document sets will not have a connection listed and will have “Document set” as the path. You can click the New Window icon in the Path column for these scans to view the child scans. Refer to Child Scans for more information.
Searching Scans
The Refine feature allows you to search the scans based on specific criteria. The search works as an “AND” statement when more than one option is applied. This is a case-sensitive search, so the search text must match the content precisely.
The Search field in the menu filters the search options only; it does not perform a search on the text entered.
Path: Search for a scan based on the exact path. This information is displayed in the Location column. This is an exact search, so you must enter the exact path to return results.
Storage platform: Search for scans on a specific storage platform. You will select the platform from a list of available storage platforms.
Impersonation User: Search for a scan based on the user being impersonated. Note that not all platforms support impersonation. This is an exact search, so the entry must match the user exactly.
Connection name: Search for a scan based on the connection name, which is the first line of text displayed in the Connection column. This is an exact search, so the entry must match the connection name exactly.
Connection user: Search for a scan based on the user account used to create the connection. This is the second line of text displayed in the Connection column. This is an exact search, so the entry must match the user exactly.
Scan Status: Search for a scan based on the scan status. If you apply a scan filter and scans within that status are missing, you may need to run the scans again. This is a known issue with how the scan execution status is calculated in the DryvIQ backend. The scan status options are:
Canceled: A user manually triggered and then manually stopped the scan.
Completed: The scan has run to its scheduled stop policy. (Stop policy configuration is only available through the REST API for content scans.) If you run a scan in “Completed” status, the stop policy will be reset.
Failed: The scan encountered a failure that caused it to stop processing.
Idle: The scan is not actively running. Scans are idle if they have never been run, require manual execution, or are scheduled but not yet in progress. The status will display “no scan” for scans that have not run yet.
Paused: The scan was triggered by a schedule but was stopped manually by a user.
Running: The scan is currently in progress.
Queued: A scan is triggered to run, but no runner is available, or the max concurrent job setting has been met.
Warning: The scan is complete but contains warnings or item failures.
Scan Date: Search for a scan based on the date the scan last ran. Select the mode (between, on, after, or before) and the date you want to use.
Has Executions?: View only scans that have been executed. Select True to view scans that had at least one scan executed. Select False to view scans that have not been executed yet.
Has child scans?: View only scans that have child scans. These are scans for mapped locations and document sets. Select True to view just these scans. Select False to exclude these scans.
Is a Document set?: View only scans for document sets. Select True to view just document set scans. Select False to exclude document set scans.
Manually Starting Scans
If you did not set a schedule for the scan when you created it, you must start it manually when you want it to run. Even if you assigned a schedule to a scan, you can manually start a scan whenever you want a scan to run outside of the scheduled time. You have the option of starting individual scans or selecting multiple scans.
Starting Individual Scans
Use the Scan button to start a scan manually. The scan information identifies the percentage of the scan that has been completed and how many files have been scanned so you can monitor the progress. Once a scan is running, the button will become a Pause button. You can use this button to stop the scan as needed.
Starting Multiple Scans
You can also start multiple scans at once if needed. If scans are set to run on a schedule, manually starting them will override the schedule and start the scan. TWhen the scan is complete, itwill continue to run as scheduled
Select the box that displays when you hover on the row.
As you select scans to start, the label for the Start scans button will change to reflect the number of selected scans. Once you finish making your selections, click the Start # scans button.
You are prompted to confirm you want to start the selected number of scans. Click OK to continue (or Cancel to cancel the action).
DryvIQ begins starting the selected scans and displays the progress. Do not refresh the page or close the browser while the scans are starting, as this will interrupt the process and cause failures.
You will see a message indicating all the scans have started. Click Close to close the modal.
Understanding the Scan Progress
The Status column displays when the last scan ran for each location and when the next scan is due to run. If a scan is running, this column will display a progress bar to indicate the progress. If scans are running for multiple locations, each location displays a progress bar that updates every minute until the scan is complete.
Some platforms report an accurate content estimate that DryvIQ can use to calculate the scan progress. For these platforms, the scan progress will reflect the true percentage of the scan progress. These scan percentages are approximations and may fluctuate based on the information provided by the platform (where applicable) or the amount of content being scanned. For example, if DryvIQ determines an estimate is wrong, it will recalculate the progress, which may decrease the progress from its previous level. Progress will then begin to increase again as the scan continues.
While SharePoint Online does provide a count estimate DryvIQ leverages to determine the scan progress, this estimate is not accurate if there are subdirectories in the source path. In this instance, the scan progress may recalculate.
For platforms that don’t provide content estimates, DryvIQ will display the following percentages based on the scan phase currently being executed:
20%: The scan is initializing and preparing to run.
30%: The scan is determining changes to the content.
40%: The scan is executing. This is when it is actively reading content and compiling the statistics for the reporting. During this phase, DryvIQ will update the number of files scanned, if any.
80%: The scan is finalizing.
100%: The scan is complete. The Scan status will display 100% for one minute after the scan completes before the last scan date displays.
For failed scans, you can click the View Activity log link to go to the Activity page to review the logged activity for the selected scan. If the scan is part of a mapped location or data set, the page displays activity for all child scans included in the mapped location or data set. A pill displays the scan ID for the selected scan or parent scan for your reference. You can use the Reset button to clear the selected scan and view all scan activity again as needed. The activity may help you understand what caused the scan to fail so you can correct any issues that can be addressed before attempting to run the scan again.
Viewing Content
You can quickly view the content for any location. Click the ellipses (…) at the end of the row and click View Content from the menu that displays. You will be taken to the Content page, filtered to display just the contents for the selected location. For mapped locations, the content will include all child locations.
Viewing Insights
You can quickly view the insights for any location. Note that the insights page that displays depends on the last insights you viewed, so you should go to the insights and select the page before coming here to select the location. Click the ellipses (…) at the end of the row and click View Insights from the menu that displays. You will be taken to the last insights page you viewed, and the charts will be filtered to display the insights for the selected location. This option is not available for the primary scan for mapped locations since there is no information to view for these scans. Insights can be viewed through the child scans.
Duplicating a Scan
Duplicating a scan allows you to create a new scan based on the settings for an existing scan. Click the ellipses (…) at the end of the row and click Duplicate Scan from the menu that displays. The Scan Setup wizard will open and automatically populate with the settings from the duplicated scan. You must select the data source you want to use for the scan and adjust any settings if needed.
When duplicating the primary scan for a document set or mapped location, the schedule will be set to scan every 6 hours since this is the default schedule for these scan types; custom schedules are applied only to the child scans. If you prefer the custom schedule used for the child scans for a document set or mapped location, you should duplicate one of the child scans instead of the primary scan so you do not need to edit the schedule.
Renaming a Scan
You can edit the scan name assigned to a scan at any time. Click the ellipses (…) at the end of the row and click Rename Scan from the menu that displays. This will open the Rename Scan modal. Edit the scan name and click OK to save the changes.
Editing Scan Types
You can update the scan types assigned to the scan. This allows you to add, remove, or adjust the scan types. Click the ellipses (…) at the end of the row and click Edit Scan Types from the menu that displays. This will open the Edit Scan Types modal. The options on this modal are the same options available when creating a content scan. Select the scan types you want to add and clear the ones you want to remove. Refer to the Scan Types section of Adding a Content Scan for more information about customizing the individual scan types.
The Reset scan option determines if a reset is performed on the next scan. A reset only resets tracking data and allows files to be rescanned. It does not remove any content from the data catalog. Once the edits are saved, the new scan types will be applied to the next scan. Scans will behave as follows based on the selected data source type.
Edited Scans With the Reset Scan Option Enabled
Location Scan: The reset forces a rescan of the entire location and publishes all entities to the data catalog again.
Mapped Location: The reset will rescan the primary location to create child scans as needed. The child scans will be reset and rescanned so the new entities can be published for all items.
Document Set: The reset will rescan to create child scans as needed.
Edited Scans Without the Reset Scan Option Enabled
Location Scan: The scan only looks for new files. Existing content will not be rescanned or updated. Only newly identified items will be scanned using the updated scan types.
Mapped Location: The scan will continue to create child scans as needed. Existing items for child scans will not be rescanned or updated. Only newly identified will be scanned using the updated scan types.
Document Set: The scan will continue to create child scans as needed. Existing items for child scans will not be rescanned or updated. Only newly identified items will be scanned using the updated scan types.
Managing Scan Schedules
You can update a scan schedule or add a schedule to a scan at any time. Click the ellipses (…) at the end of the row and click Manage Schedule from the menu that displays. This will open the Manage Schedule modal. The scheduling options here are the same options available when adding a schedule when creating a content scan. Refer to the Schedule section on the Adding a Content Scan page for more information.
The primary scan for mapped locations has a default schedule that runs every 6 hours. The schedule defined when the scan was created is assigned to the child scans and can be edited on the Child Scans page.
Removing a Scan
You can remove a scan if you no longer want the corresponding location or document set to be evaluated. Click the ellipses (…) at the end of the row and click Remove Scan from the menu that displays. Click Yes when prompted to verify you want to remove the scan.
Sorting the Grid
By default, the scans are listed in the order they were created. You can sort the locations based on any column in the grid. Clicking a column header will sort that column in ascending order. An up arrow will appear on the column to indicate the ascending sort order. Clicking the column header again will sort the column in descending order. A down arrow will appear on the column to indicate the descending sort order. Clicking the column header a third time will use the default sort order. The selected sort will persist until you change the sort order or select to sort a different column.
DryvIQ uses natural sorting. Learn more about how natural sorting works here.