FAQ Potential Topics

• E.g., Using API to integrate with Drupal
• Mapping EAD to Islandora
• ArchivesSpace-Archivematica-DSpace Workflow Integration
• Integrations

• Gear answer towards non-archivists, possibly compare with other archival applications
• Ann's comment: Maybe link to some projects that integrate ASpace with other archival systems as examples, maybe a short explanation of archival CMSs. (Need to check, but is there already a good explanation in user documentation or on the website?)
• Example question

Inspired by this question

See the Technical Documentation:

http://archivesspace.github.io/archivesspace/user/getting-started/#Start-ArchivesSpace

• 8089 – the backend
• 8080 – the staff interface
• 8081 – the public interface
• 8090 – the Solr admin console

GitHub docs

See the Technical Documentation:

http://archivesspace.github.io/archivesspace/user/backup-and-recovery/

Out of Scope (?)

Not answerable?

(Or address it by saying that it varies widely by institution, and maybe give a few examples)

List question

Some ballparks from the listserv, but this is going to vary considerably based on the institution.

• LDAP (official documentation)
• OmniAuth/CAS (user provided plugin)
• Shibboleth? (asked here)

Good step by step instructions provided by user

The technical documentation (http://archivesspace.github.io/archivesspace/user/running-archivesspace-as-a-windows-service/) plus the provided instructions are good resources.  The listserv instructions go into a great deal of detail about installing prereqs (Java, MySQL) that are not in the tech docs and could be considered out of scope.

Good listserv answer - I think we should ask Maureen Callahan for her permission to use her outline of how they do it at Yale in the FAQ.

Also a blog post about Duke's process

• Ruby examples
• Python examples
• Windows Powershell examples

The API section of the github docs has lots of good examples using curl

Answer

Also see the API documentation for /search

Need assistance, is there any official documentation for setting up subdomains?

(If not, I can write up some instructions for doing this in Apache --Rachel)

Default Setup

By default, ArchivesSpace is set up to access the public application on port 8081 and the staff application on port 8080. E.g.,

• http://aspace.myarchive.org:8081
• http://aspace.myarchive.org:8080

Subdomains

You can opt to run each application on separate subdomains. E.g.,

• http://archivesspacepublic.myarchive.org
• http://archivesspacestaff.myarchive.org
  

Under a Prefix

This document describes a simple approach for those wishing to deviate from the recommended practice of running each user-facing ArchivesSpace application on its own subdomain, and instead serve each application under a prefix. E.g.,

• http://aspace.myarchive.org/staff
  
• http://aspace.myarchive.org/public

Out of Scope

User Documentation?

Out of Scope

User Documentation

1. Enroll in Google Analytics, register your site (you don't need to include the port number in the URL)and get your tracking code (it will be a block of javascript).
2. Ensure that the local plugin is enabled in your config/config.rb (it is by default).
3. Add your tracking code to a file called plugins/local/public/views/layout_head.html.erb.
4. Restart ArchivesSpace.

No, the embedded database is only suitable for demonstration purposes. When you are ready to starting using ArchivesSpace with real users and data, you should switch to using MySQL. MySQL offers significantly better performance when multiple people are using the system, and will ensure that your data is kept safe.

For more information, see Running ArchivesSpace against MySQL.

Blog post provided by Chris

The blog post references a GitHub repo that's example of to customize the EAD exporter.  Would be nice if the how to add as a plugin info from the blog post was in the repo's readme.

Tool developed by UVA (not public though)

The application mentioned in the post is at https://github.com/uvalib/transmog

Not sure how AS-specific it is, but certainly is a fellow traveler.

Asked on listserv, no answer.

Covered by user documentation: https://docs.archivesspace.org/Default.htm#ImportCSV.htm

Script provided by user

The user documentation covers importing Digital Objects via CSV and using RDE templates.  The script referenced on the listserv provides an example of using the API to batch create digital objects and linking them as an instance of an existing archival object.

Out of Scope

User Documentation

Stylesheet provided by user

AS (and the user documentation) already covers importing MARCXML, so I wonder if this is worth including?

Asked on listserv, no answer

Some pointers on a newer thread.  Answer would basically be a pointer to the stylesheet used to generate the PDF.

Stylesheet provided on listserv

Original question was about mapping EAD to MODs for ingesting AS data into Islandora.

Listserv discussion

Couldn't find follow-ups to this, which suggests that this isn't a problem or a question asked frequently.  Also wondering if 1.5 makes this less of an issue.

Listserv answer

The listserv response, plus the same resources on the customizing export question contain examples (the Yale code says "exporter" there's a converter example there too: https://github.com/archivesspace/yale-ead-exporter/blob/master/backend/model/yale_ead_converter.rb)

Asked on listserv, no answer

Potentially the same set of examples of ead converter plugins could provide a starting point, depending on whether or not the public UI URL is derivable from the resource data.

May be caused by importing a CSV that was created through MS Excel, use Google Sheets instead (listserv discussion)

Seems more like a general why does Excel generate crappy CSV question.  Not esp unique to AS.

Suggestions in listserv thread

Seems more like a general how to format XML question.  Not esp unique to AS.

Listserv answer

Specific instructions for enabling Jasper reports are in the User Docs: https://docs.archivesspace.org/Default.htm#ReportsEnabling.htm.  Those a note about needing to enable fonts, which is important and not in the listserv answer.  If there's not a problem doing so, these could be added to the tech docs at http://archivesspace.github.io/archivesspace/user/configuring-archivesspace/ by just adding a comment or two to the right spot in the config file.

Listserv answer

The User Docs contain detailed instructions with points to external Jasper docs.  We should see if this information needs to remain in the closed User Docs or if some of it could be repurposed for technical FAQs:

http://docs.archivesspace.org/Default.htm#ReportsCustomizing.htm

http://docs.archivesspace.org/Default.htm#ReportsAdding.htm

Otherwise, maybe something as simple as:

Jasper reports can be modified by modifying the files in /reports that correspond to a given report.  For more on Jasper reports, see http://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v60/concepts-jasperreports.

Based on long discussion here

It seems that the release notes might need to be more substantial about functionality / general changes.

• When records are not showing up in search results after making changes (list question)
• Duplicate records after migrating (list question)
• Formerly deleted items or non-existent repositories are still displaying (list question)

Delete the following directories and restart ArchivesSpace:

• /path/to/archivesspace/data/solr_index
• /path/to/archivesspace/data/indexer_state

data/solr_index is the actual index, so if you delete that nothing will be searchable until the index is rebuilt.

data/indexer_state is how the indexer keeps track of what it has and hasn’t indexed. Deleting that will effectively make the indexer believe nothing is indexed and force it to be rebuilt.

You can submit possible bugs by using the "Send Feedback" button at the bottom of your ArchivesSpace instance (or the one at sandbox.archivesspace.org). When you submit a ticket, please indicate:

• Windows or Linux?
• Regular deployment or Tomcat?
• What version of ArchivesSpace?
• What version of Java?
• What are the events that happened right before you ran into the error?

Include screenshots or logs whenever possible.

Out of Scope

Are we sure we want to include? It's the only error message we had and it doesn't seem to have been heavily discussed.