diff --git a/docs/doxygen-user/data_source_summary.dox b/docs/doxygen-user/data_source_summary.dox index a32a236134..2b3898d747 100644 --- a/docs/doxygen-user/data_source_summary.dox +++ b/docs/doxygen-user/data_source_summary.dox @@ -6,9 +6,17 @@ \section ds_summary_opening Opening the Data Source Summary +There are two ways to view the data source summary. The first is to go to Case->Data Source Summary. This will open the summary in a new window. + +\image html ds_summary_window.png + +The second way to view the summary is to select the data source in the \ref tree_viewer_page and then select the "Summary" tab in the \ref result_viewer_page. + +\image html ds_summary_result_viewer.png + \section ds_summary_main Sections -Each tab of the data source summary displays different types of information about the selected data source. +Each tab of the data source summary displays different types of information about the selected data source. If ingest is ongoing, the summary will be updated periodically as new data is available. If the ingest module(s) required for a data type have not been run, you will see a note about why there is no data. For example, "Recent Programs" results are created by the \ref recent_activity_page, so you will see a message about running that module if you have not. @@ -16,16 +24,44 @@ If the ingest module(s) required for a data type have not been run, you will see \subsection ds_summary_types Types +The Types tab shows counts of different file types found in the data source. + +\image html ds_summary_types.png + \subsection ds_summary_user_activity User Activity +The User Activity tab shows the most recent results found in the data source. + +\image html ds_summary_user_activity.png + \subsection ds_summary_analysis Analysis + + \subsection ds_summary_recent_files Recent Files +The Recent Files tab shows information on the most recent files opened and downloaded. + +\image html ds_summary_recent_files.png + \subsection ds_summary_past_cases Past Cases + +\image html ds_summary_past_cases.png + + +Note that because these entries are based on the Interesting Items results created during ingest and not querying the central repository, they will not reflect any matches in cases processed after this case. For example, suppose we create Case A and ingest a data source with Device Z. If we make a new case Case B afterward and ingest a data source that also has Device Z, we would see Case A listed in this tab for Case B, but if we reopened Case A we would not see Case B listed unless ingest was run again. + \subsection ds_summary_ingest_history Ingest History +The Ingest History tab shows which ingest modules have been run on the data source and the version of each module. + +\image html ds_summary_ingest.png + \subsection ds_summary_container Container +The Container tab displays information on the data source itself, such as the size and image paths. + +\image html ds_summary_container.png + */ \ No newline at end of file diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_container.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_container.png new file mode 100644 index 0000000000..3adf7ec40d Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_container.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_ingest.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_ingest.png new file mode 100644 index 0000000000..203e9c44ee Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_ingest.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_past_cases.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_past_cases.png new file mode 100644 index 0000000000..591cb66867 Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_past_cases.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_recent_files.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_recent_files.png new file mode 100644 index 0000000000..af63e103f7 Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_recent_files.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_result_viewer.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_result_viewer.png new file mode 100644 index 0000000000..ad16f2e031 Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_result_viewer.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_types.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_types.png new file mode 100644 index 0000000000..db3f4a14f9 Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_types.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_user_activity.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_user_activity.png new file mode 100644 index 0000000000..2ce9dcaf16 Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_user_activity.png differ diff --git a/docs/doxygen-user/images/DataSourceSummary/ds_summary_window.png b/docs/doxygen-user/images/DataSourceSummary/ds_summary_window.png new file mode 100644 index 0000000000..745c3b1d97 Binary files /dev/null and b/docs/doxygen-user/images/DataSourceSummary/ds_summary_window.png differ