diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/AbstractKeywordSearchPerformer.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/AbstractKeywordSearchPerformer.java index 8fc05094df..1cfdae3774 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/AbstractKeywordSearchPerformer.java +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/AbstractKeywordSearchPerformer.java @@ -83,13 +83,22 @@ abstract class AbstractKeywordSearchPerformer extends javax.swing.JPanel impleme @Override public void search() { + boolean isRunning = IngestManager.getDefault().isModuleRunning(KeywordSearchIngestModule.getDefault()); + if (filesIndexed == 0) { - KeywordSearchUtil.displayDialog("Keyword Search Error", "No files are indexed, please index an image before searching", KeywordSearchUtil.DIALOG_MESSAGE_TYPE.ERROR); + if (isRunning) { + KeywordSearchUtil.displayDialog("Keyword Search Error", "No files are in index yet.
" + + "Try again later. Index is updated every " + KeywordSearchSettings.getUpdateFrequency().getTime() + " minutes.", KeywordSearchUtil.DIALOG_MESSAGE_TYPE.ERROR); + } + else { + KeywordSearchUtil.displayDialog("Keyword Search Error", "No files were indexed.
" + + "Re-ingest the image with the Keyword Search Module enabled. ", KeywordSearchUtil.DIALOG_MESSAGE_TYPE.ERROR); + } return; } //check if keyword search module ingest is running (indexing, etc) - if (IngestManager.getDefault().isModuleRunning(KeywordSearchIngestModule.getDefault())) { + if (isRunning) { if (KeywordSearchUtil.displayConfirmDialog("Keyword Search Ingest in Progress", "Keyword Search Ingest is currently running.
" + "Not all files have been indexed and this search might yield incomplete results.
" diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchPanel.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchPanel.java index 42576cba74..1f77cdcc47 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchPanel.java +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchPanel.java @@ -43,7 +43,7 @@ import org.apache.solr.client.solrj.SolrServerException; import org.sleuthkit.autopsy.casemodule.Case; /** - * Keyword search toolbar which allows to search for single terms or phrases + * Keyword search toolbar (in upper right, by default) which allows to search for single terms or phrases * * The toolbar uses a different font from the rest of the application, Monospaced 14, * due to the necessity to find a font that displays both Arabic and Asian fonts at an acceptable size. diff --git a/docs/QuickStartGuide/index.html b/docs/QuickStartGuide/index.html index 46b762a4bc..7fe6d0867b 100644 --- a/docs/QuickStartGuide/index.html +++ b/docs/QuickStartGuide/index.html @@ -48,27 +48,18 @@ Next, supply it with the location of the source to add.

- -

- It may take a few minutes to add the data source to the case. - During this time, an internal database is being created of the file system contents. -

-

There are a couple of options in the wizard that will allow you to make the ingest process faster. These typically deal with deleted files. @@ -77,6 +68,10 @@ Use these options to control how long the analysis will take.

+

+ Autopsy will start to analyze these data sources and add them to the case and internal database. While it is doing that, it will prompt you to configure the Ingest Modules.

+ +

Ingest Modules

You will next be prompted to configure the Ingest Modules. @@ -86,12 +81,14 @@

When you select a module, you will have the option to change its settings. For example, you can configure which keyword search lists to use during ingest and which hash databases to use. Refer to the help system inside of Autopsy for details on configuring each module.

-

- When selecting the ingest modules, you will also need to choose the update frequency. - This setting configures how often you will get updates from the ingest modules when they are running in the background. - The more frequent the updates, the longer the overall process will take. -

While ingest modules are running in the background, you will see a progress bar in the lower right. You can use the GUI to review incoming results and perform other tasks while ingest at that time. @@ -122,8 +118,10 @@

You will start all of your analysis techniques from the tree on the left.

@@ -145,6 +143,8 @@ The results will be shown in a table in the upper right.

+

You can tag (or bookmark) arbitrary files so that you can more quickly find them later or so that you can include them specifically in a report.

+

Ingest Inbox

As you are going through the results in the tree, the ingest modules are running in the background. @@ -162,6 +162,9 @@

When you select a message, you can then jump to the Results tree where more details can be found or jump to the file's location in the filesystem.

+

Timeline (Beta)

+

There is a basic timeline view that you can access via the Tools -> Make Timeline feature. This will take a few minutes to create the timeline for analysis. Its features are still in development.

+

Example Use Cases

In this section, we will provide examples of how to do common analysis tasks.

@@ -209,7 +212,7 @@

-

Copyright © 2012 Basis Technology.

+

Copyright © 2012-2013 Basis Technology.

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License. diff --git a/docs/javahelp-notes.txt b/docs/javahelp-notes.txt new file mode 100644 index 0000000000..9c68b62998 --- /dev/null +++ b/docs/javahelp-notes.txt @@ -0,0 +1,13 @@ +This is my cheat sheet for the confusing set of files that make up JavaHelp. + +- Each module has its own helpset in a docs folder under the src folder. You can create a new helpset in NetBeans UI. +- module-hs.xml is the help set file. I don't think this needs updating. +- module-map.xml maps a target name to the path where it can be found. +- module-toc.xml organizes the files to how they are displayed in the navigation tree on the left. It will merge helpsets together that have the same "text" fields in the 'tocitem' element. +- module-idx.xml allows you to map keywords to a specific file in the helpset. (NOTE: I think many existing help sets are not properly using this feature). + +Steps to add a help file: +- Create the HTML file in the docs directory (copy an existing one). +- Create an entry in module-map.xml and create a unique target name for the file. We've been using the package name to make it unique. +- Add an entry to the module-toc.xml file to place it in the right place in the structure. +