[SAK-34808] Tagging and Search capabilities Created: 11-Jan-2017  Updated: 17-Apr-2018  Resolved: 26-Mar-2017

Status: RESOLVED
Project: Sakai
Component/s: Tests & Quizzes (Samigo)
Affects Version/s: 12.0
Fix Version/s: 12.0

Type: Feature Request Priority: Major
Reporter: Diego del Blanco Orobitg Assignee: Diego del Blanco Orobitg
Resolution: Fixed Votes: 0
Labels: None

Issue Links:
Depend
depends on SAK-32082 Elastic Search Refactor to allow more... RESOLVED
depends on SAK-32083 New Tagging Service and tool RESOLVED
Relate
relates to SAK-36864 JavaScript file for tagging not found Verified
is related to SAK-34685 samigo: Make remove question confirma... OPEN
Previous Issue Keys: SAM-3115

 Description   

New feature to Tag and Search.

Allows the instructor to tag questions, and to search later for these questions by tag or by any text in the questions, to add these questions in assessments or question pools.

https://drive.google.com/open?id=0By9mWW-GZMqpaUFIMW96Sl9XT3c

REQUIRES the tag service (https://jira.sakaiproject.org/browse/SAK-32083) and the elasticsearch refactor (https://jira.sakaiproject.org/browse/SAK-32082) to work. I will do the PR once these other 2 changes are included in the trunk



 Comments   
Comment by Andrea Schmidt [ 20-Oct-2017 ]

Don't see the ability to tag questions on trunk or in 12:

https://trunk-mysql.nightly.sakaiproject.org

Sakai - 7f658204 - Sakai 13-SNAPSHOT - Server ip-172-31-6-159

https://qa2-us.nightly.sakaiproject.org

Sakai - 12.0 - QA2 09/16/2017 - Sakai 12.0-QA2 - Server ip-172-31-6-159

 

Comment by Diego del Blanco Orobitg [ 24-Oct-2017 ]

It was decided to disable the tag and search features by default. It needs to be configured in the sakai.properties. In the default sakai properties file in the code you can find the properties explained.

Comment by Andrea Schmidt [ 25-Oct-2017 ]

Is this a property I can set on a single site? If so, can you give me the name/value to set it?

Comment by Diego del Blanco Orobitg [ 25-Oct-2017 ]

It needs properties in the Sakai.properties file and it is set for all the instance, not per site.

These are the properties to define (in bold and red the mandatory to have the service working with the default values). With these you will be able to add the tags tool to the admin user, create tags collections and then use them from samigo:

Sorry for the formatting but jira changes it when pasting the properties text. Original file can be found in https://github.com/sakaiproject/sakai/blob/master/config/configuration/bundles/src/bundle/org/sakaiproject/config/bundle/default.sakai.properties from the line 4387

#TAGS

  1. If the tag service will be enabled or not. (default is true)
    tagservice.enabled=true
  1. The max size of the pages returned by the rest services in searches and lists
  2. to avoid heavy queries in big collections. (By default 200)
    #tagservice.maxpagesize=200
  1. The route inside the SAKAI folder for the full collection XML file.
  2. It will delete all the non updated tags of the collection, so
  3. it needs to be complete because after update and create the
  4. new tags, it will delete the tags that can't be found in the file. (By default tags/fullxmltags.xml)
    #tags.fullxmltagsfile=tags/fullxmltags.xml
  1. The route inside the SAKAI folder for the "one by one" update option
    #You can find samples of these files in the sources of sakai, at: /tags/tags-impl/impl/src/resources/xmlsamples
  2. (By default tags/tags.xml and tags/tagcollections.xml)
    #tags.tagsfile=tags/tags.xml
    #tags.tagcollectionsfile=tags/tagcollections.xml
  1. The route inside the SAKAI folder for the MESH collection file:
  2. It can be downloaded from (The "Descriptors" file):
  3. https://www.nlm.nih.gov/mesh/download_mesh.html
  4. ftp://nlmpubs.nlm.nih.gov/online/mesh/MESH_FILES/xmlmesh/desc2017.xml
  5. Needs to be the complete full file because after update and create the
  6. new tags, it will delete the tags that can't be found in the file.
  7. to work it needs to have previously created a collection with the external source defined as "MESH" (By default tags/mesh.xml)
    #tags.meshcollectionfile=tags/mesh.xml
  1. The email address that will receive the confirmation mails from the import jobs (by default uses the defined in portal.error.email)
    #tags.import_job_email=youremail@yourdomain.ext
  1. ###############################
    #SAMIGO SEARCH AND TAGS
  2. ###############################

#show the search question option in the question creation page (default is false)
#This needs elasticsearch service working
samigo.question.show.showSearchQuestion=true

#Limit the max number of search results to appear in the search question (50 by default)
#samigo.search.maxResults=50

#Allow the use of tags in samigo in the authoring part(default is false)
samigo.author.usetags=true

#Allows the instructors to delete tags from a question. (default is true)
#samigo.author.allowDeleteTags=false

#Allow the display of tags in the grading part (default is false)
#samigo.evaluation.usetags=false

#MULTI-TAGS PROPERTIES
#If true, the tags will be updated in all the questions identical to the one edited (same hash). (default is false)
#If this is enabled, it has preference over the value in samigo.author.multitag.singlequestion.check, so no check will appear to the user and the tags will be updated in any case. (Note: The admin user will always view the check)
#samigo.author.multitag.singlequestion=false

#If true, the tags will be updated in all the questions identical to the one edited (same hash) based on a check in the interface. (default is false)
#If samigo.author.multitag.singlequestion is true it has preference over this one, so the check won't appear to the user and the saving in all the same hash questions will happen always.
#If both samigo.author.multitag.singlequestion and samigo.author.multitag.singlequestion.check are false,

  1. the tags will be independent in every question and saving one question won’t affect any other question.
    #samigo.author.multitag.singlequestion.check=false
Comment by Andrea Schmidt [ 25-Oct-2017 ]

Thank you for so much detail!

Comment by Neal Caidin [ 27-Oct-2017 ]

Diego del Blanco Orobitg , do you mind putting this information in a Confluence page?

Could be linked off here:

https://confluence.sakaiproject.org/display/DOC/Sakai+Features

 

Comment by Diego del Blanco Orobitg [ 02-Nov-2017 ]

Here is some documentation about the service, and the samigo features. Feel free to move to other places it you feel that it should be there,

https://confluence.sakaiproject.org/display/DOC/Tagging+Service+and+Samigo+tagging+and+search

2 of the documents are the changes needed in the Sakai manual.

Generated at Mon Sep 23 09:36:40 CDT 2019 using Jira 8.0.3#800011-sha1:073e8b433c2c0e389c609c14a045ffa7abaca10d.