Add facets for Archival Description search results

[drba...@ucalgary.ca]

Good morning,

I'm wondering what would be involved in adding a new set of facets, under "Narrow your results by:", on the Archival Description search results page.

My users would like to add some metadata to description records for "themes" (different from thematic access points on archival institutions, but the same idea). It seems they don't want to use the Subject taxonomy, or at least would like to differentiate from Subjects in the facets on the search page.

Thanks for any help you can give!

Damian

[Dan Gillean]

Hi Damian, 

If they don't want to sue the Subjects taxonomy, then... are you suggesting this work would also involve adding a whole new Taxonomy for managing Theme-based controlled vocabulary terms (a bit similar to the Thematic Area taxonomy and facet used on the Repository browse page in multi-repository sites)?

If yes, then... this is definitely beyond the kind of guidance we can offer via the user forum, as this is not one but two major development undertakings, and will require an understanding of pretty much all parts of AtoM to implement. 

I will provide some links to general development resources below - I would suggest that your developers spend some time reviewing these, as well as studying AtoM's existing code base. In particular, why not search for commits and/or pull requests from previous work that implement similar features and changes, so they can see what was involved?

Once they have a better sense of how AtoM's code is organized and how similar features have been implemented in the past, perhaps we can help with some more specific questions. In the meantime, some resources: 

First, the documentation has a VERY high-level overview of AtoM, here: 

• https://www.accesstomemory.org/docs/latest/user-manual/overview/intro/

We have some slide decks that offer a more developer-focused introduction: 

• Get to know AtoM's codebase
• AtoM feature development - introduction
• There are others on our SlideShare account that might be tangentially useful, such as how to construct SQL queries in AtoM, how to develop custom themes, etc. 

If you want to undertake AtoM feature development, then you need to understand the Symfony 1.x framework. Some legacy resources from Symfony that are still relevant for AtoM: 

• https://symfony.com/legacy 

AtoM uses Elasticsearch 5.6 at the moment so you might want to look at the ES 5.6 docs as well. The vast majority of AtoM's ES configuration is contained in the following two files: 

• https://github.com/artefactual/atom/blob/qa/2.x/plugins/arElasticSearchPlugin/config/search.yml
  
• https://github.com/artefactual/atom/blob/qa/2.x/plugins/arElasticSearchPlugin/config/mapping.yml

You will find some additional resources on our wiki, such as: 

• General development resources
• Entity relationship diagrams
• Recommendations in case you intend to contribute your work back to the public project
• etc

Finally, I would also suggest looking in AtoM's commit history and trying to find commits and/or pull requests that add similar function, so you can study what was changed. For example, in release 2.4 we added a new Occupations access point to the Actors module (i.e. authority records), and that also included adding a new Occupations taxonomy to store the terms added: 

• https://github.com/artefactual/atom/commit/67f0e48bc6201317eaf97e798ecc7bcf009a4b9c
  

AtoM has changed somewhat since 2.4 obviously, but this alone should give your developers a lot of initial guidance. One more that might be interesting to review: 

• https://github.com/artefactual/atom/commit/b3cd2b678b693b79ad40c19fda2e1ee9c21ff570

I hope this helps! 

Dan Gillean, MAS, MLIS
AtoM Program Manager
Artefactual Systems, Inc.
604-527-2056

@accesstomemory

he / him

--
You received this message because you are subscribed to the Google Groups "AtoM Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ica-atom-user...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/ica-atom-users/ad46eeb0-e146-473c-8915-5815170cb34fn%40googlegroups.com.

[drba...@ucalgary.ca]

Thanks, Dan, very helpful!

I'll review those resources and we'll decide if it's worth the development time.

Cheers,

Damian