Skip to content

Commit

Permalink
update search csv export
Browse files Browse the repository at this point in the history
  • Loading branch information
fiver-watson committed Apr 27, 2016
1 parent a5f1e19 commit 6782dee
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions user-manual/import-export/csv-export.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,41 +228,51 @@ export it, and begin a second CSV - and so on.

.. _csv-export-search:

Export advanced search results in CSV format
============================================
Export search and browse results in CSV format
==============================================

Any authenticated (i.e. logged in) user can generate a :term:`CSV` export of
:term:`advanced search` results. The CSV export, after it is generated, is
made available for download from the jobs page.
:ref:`search-atom` or :ref:`browse` results. The CSV export, after it is
generated, is made available for download from the jobs page.

.. SEEALSO::

* :ref:`advanced-search`
* :ref:`search-atom`
* :ref:`browse`
* :ref:`manage-jobs`

When downloaded, the file will be compressed in a
`ZIP <https://wikipedia.org/wiki/Zip_(file_format)>`__ archive - there are many
free utilities (likely there is one already included on your computer) that
will allow you to "unzip" a ZIP file.

**To generate and download a CSV export of advanced search results:**

1. Navigate to the :ref:`advanced-search` page. You can get there by placing
your cursor in the global :term:`search box` - a :term:`drop-down menu`
will appear, with a link to the advanced search page. Click on the link to
navigate to the Advanced search page. For more information see:
:ref:`search box <search-box>` and :ref:`advanced-search`.
2. Perform a search. For more information on working with the fields and
filters available on the advanced search page, see:
:ref:`advanced-search-interface`.
**To generate and download a CSV export of search or browse results:**

1. Navigate to the :term:`archival description` :ref:`browse` page. You can
get there using the :term:`browse menu` located in the AtoM
:term:`header bar` - for more information, see: :ref:`browse-menu`. You can
also perform a search directly via the global :term:`search box` in the AtoM
header bar, or by placing your cursor in the search box, selecting "Advanced
search" from the :term:`drop-down menu` that appears, and then using the
:term:`advanced search panel` to perform a search. For more information,
see: :ref:`search-atom` and :ref:`advanced-search`
2. If you wish to limit the results returned based on a search query
before exporting, perform a search using the :term:`advanced search panel`,
and/or limit the results using the :term:`facet filters <facet filter>`
available in the left column. For more information on working with the
fields and filters available on the advanced search panel, see:
:ref:`advanced-search-interface`. For information on using the facets, see:
:ref:`recurring-facet-filters`; particularly, :ref:`using-facet-filters`.

.. image:: images/advanced-search-example.*
:align: center
:width: 85%
:alt: An example query on the advanced search page

3. When you want to export the search results returned, click on the "Export
CSV" link at the top right of the page.
CSV" link - it's located below the :term:`advanced search panel`, but
above the results, on the left.

.. image:: images/search-csv-export-button.*
:align: center
Expand All @@ -271,9 +281,9 @@ will allow you to "unzip" a ZIP file.

.. NOTE::

Public users will not be able to see this export link. Currently, the
advanced search CSV export feature is only available to authenticated (i.e.
logged in) users.
Public users will **not** be able to see this export link. Currently, the
search CSV export feature is only available to authenticated (i.e. logged
in) users.

4. The CSV export of the search results will be generated by the job
scheduler. After clicking the "Export CSV" link, AtoM will reload the page
Expand Down
Binary file modified user-manual/import-export/images/advanced-search-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified user-manual/import-export/images/search-csv-export-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified user-manual/import-export/images/search-csv-export-jobs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6782dee

Please sign in to comment.