Skip to content

User Manual

Jump to bottom
crugas edited this page Dec 11, 2023 · 1 revision

Quick Start

  1. Install the program by downloading the .exe file from the latest release
  2. Follow the on-screen instructions to install the application, then run it.
  3. Login to your local ArchivesSpace instance with your ArchivesSpace credentials, including your username, password, and API URL
  4. Enter the barcodes or top container URIs in the left column, separated by newline (enter) of the archival objects you want retrieved and parsed
  5. Select your repository (click SAVE to remember this selection)
  6. Select the ASpace>DLG Template file that will be used to copy to make the new spreadsheet. This will be saved.
  7. Select START
  8. The GUI may go unresponsive if there are a lot of archival objects. Let it run until the START button is active.
  9. Select Open Output Folder to find the new spreadsheet

Process

ArchivesSpace Login

Upon starting the application, the user must first log in to their ArchivesSpace instance, entering the following info:

  • ArchivesSpace username (not saved to defaults)
  • ArchivesSpace password (not saved to defaults)
  • ArchivesSpace API URL (saved to defaults)

ArchivesSpace_login_popup

Click "Save and Continue" to login and continue to the main screen. Your username and password will not be saved next time you log in, but your API URL will be saved. If there are any errors with logging in, a popup screen should appear displaying the error. Contact your local system administrator or create an issue for help troubleshooting any errors. See example error below:

ArchivesSpace_login_error_message

Main Screen

Here is where you will enter your barcodes, select your ArchivesSpace repository, and your spreadsheet template file. First, enter the barcodes of the top containers OR the top container URIs found in ArchivesSpace in the "Enter Barcodes or Top Container URIs" box, separated by newline.

Enter_barcodes_or_top_container_uris_box_highlighted

Next, select your repository from the drop-down menu. This list is automatically generated when you login to ArchivesSpace. Click "SAVE" to save this selection to your default.

select_repo_from_dropdown

Either click "Select ASpace>DLG Template" and select the spreadsheet template from the File Explorer or fill in the filepath in the blank box. Only .xlsx file types are allowed and will appear if you select to browse via the file explorer.

select_spreadsheet_template_file

Click "START" to begin the process. The application will print out statements of what archival objects it has found and is populating in the spreadsheet in the Console window below. If there are any errors with particular archival objects, you will see a question mark at the end of the generated DLG ID

run_aspace_dlg_spreadsheet_generator-001

To see the spreadsheet that was generated, select "Open Output Folder". It will open File Explorer to the folder where the new spreadsheet is found.

output_folder_with_spreadsheet

Defaults

The following settings can be set to save for a user after they select an option:

  • ArchivesSpace API URL
  • ArchivesSpace Repository (must click "SAVE")
  • ASpace>DLG Template file

The output folder where new spreadsheets are generated defaults to "output_files" folder generated when first running the application. This folder exists on the same file level as the program files.

Clone this wiki locally