Tags Administration. Sakai Properties

 

1. SAKAI PROPERTIES


1.1 TAG SERVICE PROPERTIES

The tag service has a set of properties provided for configuration:


1.1.1 ENABLE THE SERVICE:

  • Enables the tag service. (default is true)

tagservice.enabled=true

 (NOTE: At this time, disabling the tag service will only disable the admin tool.  Other features will still be available. In the future disabling the tag service will also disable the service.)


1.1.2 MAX NUMBER OF TAGS RETURNED BY THE REST SERVICES IN A PAGE

  • Sets the max size of the pages returned by the rest services in searches and lists to avoid large queries in big collections. (Default is 200)

tagservice.maxpagesize=200


1.1.3 CONFIGURATION OF THE IMPORT JOBS

The options will be defined later in this document.


1.1.3.1 UPDATE FULL COLLECTION

  • Defines the path inside the SAKAI folder for the full collection XML file.

  • This process will delete all the tags not included in the collection and as a result, the update needs to contain a full set of tags.  The final step following the update and creation of the new tags will be to delete any tags of this collection in database not found in the update file. (By default tags/fullxmltags.xml)

tags.fullxmltagsfile=tags/fullxmltags.xml


1.1.3.2 UPDATE INDIVIDUAL TAGS

  • Defines the path inside the SAKAI folder for the "one by one" tag update option

  • Samples of these files can be found in the SAKAI source, at:

    • /tags/tags-impl/impl/src/resources/xmlsamples (By default tags/tags.xml  and tags/tagcollections.xml)

tags.tagsfile=tags/tags.xml

tags.tagcollectionsfile=tags/tagcollections.xml


1.1.3.3 UPDATE MESH COLLECTION FILE

  • Defines the path inside the SAKAI folder for the MESH collection file:

  • The file can be downloaded from (The "Descriptors" file):

  • This process will delete all the tags not included in the collection and as a result, the update needs to contain a full set of tags.  The final step following the update and creation of the new tags will be to delete any tags of this collection in database not found in the update file.  For this process 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.1.3.4 EMAIL CONFIRMATION

  • Defines the email address that will receive the confirmation emails from the import jobs (by default uses the defined email address in portal.error.email)

tags.import_job_email=yourmail@amailserver.net


1.2 SAMIGO-TAG RELATED PROPERTIES


1.2 1 SEARCH QUESTIONS

  • Initiates the search question option in the question creation page (default is true)

  • This needs elasticsearch service working

samigo.question.show.showSearchQuestion=true


  • Set the limit for the max number of search results to appear in the search question (50 by default)

samigo.search.maxResults=50


1.2.2 TAG SPECIFIC PROPERTIES


1.2.2.1 ALLOW TAGS FOR AUTHORING

  • Allow the use of tags in samigo for authoring a question. (default is true)

samigo.author.usetags=true


1.2.2.2 ALLOW INSTRUCTORS TO DELETE TAGS

  • Allow instructors to delete tags from a question. (default is true)

samigo.author.allowDeleteTags=false


1.2.2.3 ALLOW DISPLAY OF TAGS IN GRADING

  • Allow the display of tags in the grading. (default is false) 

samigo.evaluation.usetags=true


1.2.3 MULTI-TAGS PROPERTIES


1.2.3.1 OVERRIDE MATCHING QUESTION CHECK

  • If this property is set to true, all tags will be updated for all the questions identical to the question edited (identical hash value). (default is false)

    • Overrides the value set in samigo.author.multitag.singlequestion.check.

      • The checkbox does not appear to a normal user. A message displays indicating all matching questions will be updated

      • An admin user will always be provided with the checkbox.

samigo.author.multitag.singlequestion=true


1.2.3.2 PROVIDE SINGLE QUESTION UPDATE - NON-ADMIN USERS

  • Override matching question check is not set. (samigo.author.multitag.singlequestion=false)

  • If this property is set to true, all tags will be updated for all the questions identical to the question edited when the checkbox is selected (identical hash value). (default is false)

    • The checkbox appears for both normal and admin users.

samigo.author.multitag.singlequestion.check=true



1.2.3.3 SINGLE QUESTION UPDATE NOT ALLOWED - NON-ADMIN USERS

  • Override matching question check is not set. (samigo.author.multitag.singlequestion=false)

  • Allowing single question update is not set. (samigo.author.multitag.singlequestion.check=false)

  • The checkbox will not be displayed for a normal user.

  • The checkbox will be displayed for an admin user.

The three combinations for a normal user are:


1. Normal users will not see a checkbox or message and the tags are only saved for the current question being updated.

samigo.author.multitag.singlequestion=false

samigo.author.multitag.singlequestion.check=false


2. Normal users see a checkbox and a message to indicate if they want to update all questions identical (hash value) to the current question they are editing. samigo.author.multitag.singlequestion=false

samigo.author.multitag.singlequestion.check=true


3. Normal users will see a message explaining that the tags will be saved to all questions identical (hash value) to the current question they are editing. There is no ability for a normal user to turn this function off based on the settings of the properties as shown below.

samigo.author.multitag.singlequestion=true and

(samigo.author.multitag.singlequestion.check=false or

samigo.author.multitag.singlequestion.check=true)

 

Note: Admin users will always view the checkbox to decide, so these options are not affecting them, except because if samigo.author.multitag.singlequestion=false the checkbox is unchecked by default and if true, then is checked by default.



1.3 ELASTIC SEARCH

The elastic search service does not require the setting of any specific property related with tags or samigo questions search, but it needs to be enabled to allow the search to work.

  • Enable the elastic search. (Default is false)

search.enable=true