Difference between revisions of "Data View"
Andydufton (talk | contribs) (→Search Filters) |
|||
| (50 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
| − | + | [[image:search.png|right|frame|Example of search results in table view, full page]] | |
| − | + | ==Search - Data View Overview== | |
| + | This page is designed to enable user and administrator apply basic and advanced search functions on the ARK database, with the options of viewing and exporting the data using a variety of tools provided. Search filters can be saved, and the results exported in a variety of means including RSS and Atom feeds as well as simple PDF or CSV formats. The following gives a short introduction to the basic functions provided on this page with the hopes of enabling and allowing users access to searching the ARK database. | ||
| − | + | ==View and Export Options== | |
| + | [[image:search_tools.png|left|frame|Search tools located above the main panel in the search page]] | ||
<br> | <br> | ||
<br> | <br> | ||
| + | |||
| + | |||
| + | Along the top of the main panel of the search page is a custom tool bar containing several options for configuring, viewing, and exporting the search output. | ||
| + | |||
| + | ===View Tools=== | ||
| + | [[Image:search_fieldconfig.png|left|frame|Example of configuring visible fields in the search results]] | ||
| + | |||
| + | *'''Configure Fields for Text, Table, and Map Views''' [[Image:gears.png]] | ||
| + | This tool allows for users to configure (add and remove) fields from the search results page. By first clicking on the gears icon, a window appears listing the current fields listed in the search view. In order to remove fields from the search view, press the the [[image:clear.png]] button to the right of the field name. In order to view additional fields, use the drop down at the bottom of the window and click 'go'. The fields that appear in this list are configured by the ARK administrator, thus please contact your administrator if you would like additional fields to be added to the drop-down. | ||
| + | |||
| + | [[Image:search_text.png|left|frame|Example of text view of search results]] | ||
| + | *'''Text View''' [[Image:text_icon.png]] | ||
| + | Displays a short Google-style excerpt for each search result. This generally includes the record number, and other configurable fields describing the record. Each record also lists the pre-configured navigation options including [[image:view.png]] and [[image:detailed_icon.png]] as well as the added function of removing individual records from the search results using the [[image:clear.png]] (This will vary depending upon the options set up by ARK administrator). Please see your ARK administrator if you want to further customize this view, and add or subtract fields which are not available in the configure fields options (See above [[Image:gears.png]]). | ||
| + | |||
| + | [[Image:search_tbl.png|left|frame|Example of table view of search results]] | ||
| + | *'''Table View''' [[Image:table_icon.png]] | ||
| + | Displays a table with basic information about each result. The structure of the table will generally mirror the [[Data Entry#Data Entry Register|Data Entry Register]], but is designed to enable users greater flexibility when sorting the data. Field headings which are highlighted along the top of the table have been enabled to allow for ascending and descending sorting of the search results. Please see your ARK administrator if you want to further customize this view, and add or subtract fields which are not available in the configure fields options (See above [[Image:gears.png]]). | ||
| + | |||
| + | *'''Map View''' [[Image:map_icon.png]] | ||
| + | Displays a map view highlighting all the search results on a map, with a text view along the right hand side of the main panel. By hovering over a highlighted result on the map, the context number will appear in a dedicated window. Clicking on this window you can link directly to a specific record. The map view is only available if a web mapping service (containing associated spatial data) has been set up for the ARK project, please contact your ARK administrator if you have questions regarding this. | ||
| + | |||
| + | *'''Multiple Record View''' [[Image:multiple_icon.png]] | ||
| + | This view opens a new browser window or tab view and displays every record (and associated data) in one view. This view is mirrors to look and feel of the micro view, however displays all records resulting from the search. The primary purpose of this view is to then use the browser 'Print to PDF' functionality to export a PDF (for example) of all search results and associated data. The forms displayed within this view are configured by the ARK administrator. Please be aware that this function is heavily reliant upon the number of records contained within the search results and associated data, thus a large number of results may take a few moments to create the multiple record view- so, Be Patient! | ||
| + | |||
| + | ===Export Data=== | ||
| + | *'''RSS and Atom Feeds''' [[Image:rss_atom_icon.png]] | ||
| + | |||
| + | |||
| + | [[image:export_download.png|left|frame|Example of the successful preparation of a downloadable CSV file of the search results in the search page ]] | ||
| + | |||
| + | *'''Export to CSV''' [[Image:csv_icon.png]] | ||
| + | This export option will prompt for you to download a CSV (Comma Separated Values) file of the search result. By pressing 'go' a file is then prepared containing the results of the search, and by pressing the 'Download' button, the download of the CSV file begins. This file can then be imported as a table into a standard spreadsheet or database program (Open Office, Excel, Access, etc) or text file reader. | ||
<br> | <br> | ||
<br> | <br> | ||
| + | |||
| + | ==Main Panel== | ||
| + | |||
| + | [[image:search_main.png|left|frame|An example of the main panel containing search results, viewed as table]] | ||
| + | |||
| + | The main panel of the search page holds the results of searches and is used for manipulating large collections of data. Using the [[Data View#Search Filters|Search Filters]] a set of data can be obtained, viewed, and exported. The main panel lists the total number of search results, and allows paging through search results using the page numbers at the bottom of the main panel, with a 'view all' option that displays all records in the search results in one page. Data is displayed in the main panel according to [[Data View#View and Export Options|View Tools]] selected. | ||
<br> | <br> | ||
<br> | <br> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Search filters are used to | + | ==Search Filters== |
| + | |||
| + | Search filters are used to filter the data based on a given set of criteria. Before searching, be sure to understand the different types of [[Data Class]] used, as it's helpful to have a basic understanding of this terminology to make the most of the searching within ARK. | ||
| + | |||
| + | [[image:search_lpanel.png|left|frame|An example of the left panel in the search page, with preconfigured search types.]] | ||
| + | |||
| + | ===Filter Tools=== [[Image:search_lpaneltools.png|right|frame|Filter tools to be applied to all active search filters]] | ||
| + | Several filter tools exist in the top of the left panel to assist with the process of applying search filters to the ARK database. | ||
| + | |||
| + | *'''Clear All Filters''' [[Image:search_clear.png]] | ||
| + | This tool clears all filters, or search parameters being applied to the database. By clicking this button all search 'terms' are removed, and the search results displayed in the main panel will become empty. Alternatively, individual filters can be removed by using the [[Image:search_clear.png]] positioned to the right of each search term listed below the filter tools in the left panel. | ||
| + | |||
| + | *'''Refresh All Filters''' [[Image:search_refresh.png]] | ||
| + | This tool refreshes all filters, or search parameters being applied to the database. By clicking this button all search 'terms' are refreshed, and return the search results within the main panel. | ||
| − | [[ | + | *'''Save Filters''' [[Image:search_save.png]] |
| + | This tool saves all filters, or search parameters being applied to the database to a user-specific 'filter set'. After pressing the save icon, the user will be prompted to type a name (in the text box provided) identifying the filter for future use. These user-saved filters will then be listed in the left panel, or as configured by the ARK administrator. Administrators will then have the option of making user filters 'public' for all users in the ARK system. | ||
| + | ===Filter Types=== | ||
The main types of search are outlined below: | The main types of search are outlined below: | ||
*'''Free Text Search''' - A search based on a text string. The search filter looks in all text fields, and may return all types of record. | *'''Free Text Search''' - A search based on a text string. The search filter looks in all text fields, and may return all types of record. | ||
| Line 36: | Line 85: | ||
The search function is likely to be restructured in future ARK releases to imrpove this process and include more complex searching options. | The search function is likely to be restructured in future ARK releases to imrpove this process and include more complex searching options. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[category: Usermanual]] | [[category: Usermanual]] | ||
Latest revision as of 15:20, 20 September 2011
Contents
Search - Data View Overview
This page is designed to enable user and administrator apply basic and advanced search functions on the ARK database, with the options of viewing and exporting the data using a variety of tools provided. Search filters can be saved, and the results exported in a variety of means including RSS and Atom feeds as well as simple PDF or CSV formats. The following gives a short introduction to the basic functions provided on this page with the hopes of enabling and allowing users access to searching the ARK database.
View and Export Options
Along the top of the main panel of the search page is a custom tool bar containing several options for configuring, viewing, and exporting the search output.
View Tools
- Configure Fields for Text, Table, and Map Views
This tool allows for users to configure (add and remove) fields from the search results page. By first clicking on the gears icon, a window appears listing the current fields listed in the search view. In order to remove fields from the search view, press the the 
button to the right of the field name. In order to view additional fields, use the drop down at the bottom of the window and click 'go'. The fields that appear in this list are configured by the ARK administrator, thus please contact your administrator if you would like additional fields to be added to the drop-down.
- Text View
Displays a short Google-style excerpt for each search result. This generally includes the record number, and other configurable fields describing the record. Each record also lists the pre-configured navigation options including 
and 
as well as the added function of removing individual records from the search results using the (This will vary depending upon the options set up by ARK administrator). Please see your ARK administrator if you want to further customize this view, and add or subtract fields which are not available in the configure fields options (See above 
).
- Table View
Displays a table with basic information about each result. The structure of the table will generally mirror the Data Entry Register, but is designed to enable users greater flexibility when sorting the data. Field headings which are highlighted along the top of the table have been enabled to allow for ascending and descending sorting of the search results. Please see your ARK administrator if you want to further customize this view, and add or subtract fields which are not available in the configure fields options (See above ).
- Map View
Displays a map view highlighting all the search results on a map, with a text view along the right hand side of the main panel. By hovering over a highlighted result on the map, the context number will appear in a dedicated window. Clicking on this window you can link directly to a specific record. The map view is only available if a web mapping service (containing associated spatial data) has been set up for the ARK project, please contact your ARK administrator if you have questions regarding this.
- Multiple Record View
This view opens a new browser window or tab view and displays every record (and associated data) in one view. This view is mirrors to look and feel of the micro view, however displays all records resulting from the search. The primary purpose of this view is to then use the browser 'Print to PDF' functionality to export a PDF (for example) of all search results and associated data. The forms displayed within this view are configured by the ARK administrator. Please be aware that this function is heavily reliant upon the number of records contained within the search results and associated data, thus a large number of results may take a few moments to create the multiple record view- so, Be Patient!
Export Data
- RSS and Atom Feeds
- Export to CSV
This export option will prompt for you to download a CSV (Comma Separated Values) file of the search result. By pressing 'go' a file is then prepared containing the results of the search, and by pressing the 'Download' button, the download of the CSV file begins. This file can then be imported as a table into a standard spreadsheet or database program (Open Office, Excel, Access, etc) or text file reader.
Main Panel
The main panel of the search page holds the results of searches and is used for manipulating large collections of data. Using the Search Filters a set of data can be obtained, viewed, and exported. The main panel lists the total number of search results, and allows paging through search results using the page numbers at the bottom of the main panel, with a 'view all' option that displays all records in the search results in one page. Data is displayed in the main panel according to View Tools selected.
Search Filters
Search filters are used to filter the data based on a given set of criteria. Before searching, be sure to understand the different types of Data Class used, as it's helpful to have a basic understanding of this terminology to make the most of the searching within ARK.
Several filter tools exist in the top of the left panel to assist with the process of applying search filters to the ARK database.
- Clear All Filters
This tool clears all filters, or search parameters being applied to the database. By clicking this button all search 'terms' are removed, and the search results displayed in the main panel will become empty. Alternatively, individual filters can be removed by using the 
positioned to the right of each search term listed below the filter tools in the left panel.
- Refresh All Filters
This tool refreshes all filters, or search parameters being applied to the database. By clicking this button all search 'terms' are refreshed, and return the search results within the main panel.
- Save Filters
This tool saves all filters, or search parameters being applied to the database to a user-specific 'filter set'. After pressing the save icon, the user will be prompted to type a name (in the text box provided) identifying the filter for future use. These user-saved filters will then be listed in the left panel, or as configured by the ARK administrator. Administrators will then have the option of making user filters 'public' for all users in the ARK system.
Filter Types
The main types of search are outlined below:
- Free Text Search - A search based on a text string. The search filter looks in all text fields, and may return all types of record.
- Filter by Item - A search filter for a specific type of record (egs. contexts, special finds, photos, files, etc).
- Filter by Attribute - A search for a specific attribute of a record (egs. findtypes, period, etc).
- Filter by Site Code - A filter for ARKs with multiple site codes, returns all records from the requested code.
- Filter by Actor - A search for a specific Actor, returns all records that are in some way attached to this actor.
To complete a search, select the data class to be searched from the right-hand 'Data Toolbox'. Either enter the text string, or select the type or attribute from a dropdown list, and select 'Search'. You can narrow down your results by creating multiple filters until reaching the desired result. For example, after searching for all Special Finds (Item-->Special Find), the search could be further refined by searching for the text 'Gold' (Free Text-->'Gold'). This would return a set of all Special Find records including the word 'Gold'. To save the search within your ARK profile, type in a nickname for the results set and hit 'Save'.
The search function is likely to be restructured in future ARK releases to imrpove this process and include more complex searching options.
