Upload New File

359bf677 · Marco Del Tufo · dee7b77b · 359bf677
Commit 359bf677 authored 1 year ago by Marco Del Tufo
--- a/docs/uncategorized/ad-hoc-vocabulary-terms.md
+++ b/docs/uncategorized/ad-hoc-vocabulary-terms.md
+[Log
+in](https://unlimited.ethz.ch/login.action?os_destination=%2Fdisplay%2FopenBISDoc2010%2FAd%2BHoc%2BVocabulary%2BTerms)
+
+Linked Applications
+
+Loading…
+
+[![Confluence](/download/attachments/327682/atl.site.logo?version=1&modificationDate=1563454119905&api=v2)](/)
+
+-   [Spaces](/spacedirectory/view.action "Spaces")
+-   [Create ](# "Create from template")
+
+-   Hit enter to search
+
+-   [Help](# "Help")
+    -   [Online
+        Help](https://docs.atlassian.com/confluence/docs-82/ "Visit the Confluence documentation home")
+    -   [Keyboard Shortcuts](# "View available keyboard shortcuts")
+    -   [Feed
+        Builder](/dashboard/configurerssfeed.action "Create your custom RSS feed.")
+    -   [What’s
+        new](https://confluence.atlassian.com/display/DOC/Confluence+8.2+Release+Notes)
+    -   [Available Gadgets](# "Browse gadgets provided by Confluence")
+    -   [About
+        Confluence](/aboutconfluencepage.action "Get more information about Confluence")
+
+-   
+
+-   
+
+-   
+
+-   [Log
+    in](/login.action?os_destination=%2Fdisplay%2FopenBISDoc2010%2FAd%2BHoc%2BVocabulary%2BTerms)
+
+  
+
+[![openBIS Documentation Rel.
+20.10](/images/logo/default-space-logo.svg)](/display/openBISDoc2010/openBIS+Documentation+Rel.+20.10+Home "openBIS Documentation Rel. 20.10")
+
+[openBIS Documentation Rel.
+20.10](/display/openBISDoc2010/openBIS+Documentation+Rel.+20.10+Home "openBIS Documentation Rel. 20.10")
+
+-   [Pages](/collector/pages.action?key=openBISDoc2010)
+-   [Blog](/pages/viewrecentblogposts.action?key=openBISDoc2010)
+
+### Page tree
+
+[](/collector/pages.action?key=openBISDoc2010)
+
+Browse pages
+
+ConfigureSpace tools
+
+[](#)
+
+-   [ ](#)
+    -   [ Attachments (9)
+        ](/pages/viewpageattachments.action?pageId=53746007 "View Attachments")
+    -   [ Page History
+        ](/pages/viewpreviousversions.action?pageId=53746007)
+
+    -   [ Page Information ](/pages/viewinfo.action?pageId=53746007)
+    -   [ Resolved comments ](#)
+    -   [ View in Hierarchy
+        ](/pages/reorderpages.action?key=openBISDoc2010&openId=53746007#selectedPageInHierarchy)
+    -   [ View Source
+        ](/plugins/viewsource/viewpagesrc.action?pageId=53746007)
+    -   [ Export to PDF
+        ](/spaces/flyingpdf/pdfpageexport.action?pageId=53746007)
+    -   [ Export to Word ](/exportword?pageId=53746007)
+    -   [ View Visio File
+        ](/plugins/lucidchart/selectVisio.action?contentId=53746007)
+
+    -   [ Copy
+        ](/pages/copypage.action?idOfPageToCopy=53746007&spaceKey=openBISDoc2010)
+
+1.  [Pages](/collector/pages.action?key=openBISDoc2010)
+2.  **…**
+3.  [openBIS Documentation Rel. 20.10
+    Home](/display/openBISDoc2010/openBIS+Documentation+Rel.+20.10+Home)
+4.  [openBIS 20.10
+    Documentation](/display/openBISDoc2010/openBIS+20.10+Documentation)
+5.  [Guides](/display/openBISDoc2010/Guides)
+
+-   []( "Unrestricted")[](/pages/viewpageattachments.action?pageId=53746007&metadataLink=true "9 attachments")
+-   [Jira links]()
+
+[Ad Hoc Vocabulary Terms](/display/openBISDoc2010/Ad+Hoc+Vocabulary+Terms)
+--------------------------------------------------------------------------
+
+-   Created by [Fuentes Serna Juan Mariano
+    (ID)](%20%20%20%20/display/~juanf%0A) on [Oct 01,
+    2020](/pages/viewpreviousversions.action?pageId=53746007 "Show changes")
+
+Ad Hoc Vocabulary Terms
+-----------------------
+
+### Introduction
+
+*Ad Hoc Vocabulary Term* is a special kind of Vocabulary Term. If needed
+term is missing in the vocabulary, it can be added by Power User when
+filling up the form.
+
+### Creating new Ad Hoc Vocabulary Term
+
+Ad Hoc Vocabulary Terms can be created either via web interface of
+openBIS, or by DataSet Uploader. Below you can learn how to do it in
+both cases.
+
+#### openBIS
+
+When filling up the forms in openBIS, Power User will see next to the
+drop down list a plus icon (see picture below).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-21%20at%201.29.04%20PM.png?version=1&modificationDate=1601541479493&api=v2)
+
+By clicking on the icon, user can add Ad Hoc Vocabulary Term. A dialog
+appears (similar to one on screenshot below), in which it is possible to
+specify label, description and position on list of terms. The code will
+be generated automatically from the label.
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-21%20at%201.31.11%20PM.png?version=1&modificationDate=1601541479492&api=v2)
+
+User can easily distinguish between regular, and Ad Hoc Vocabulary Term
+- the second one is shown in *italic grey* (see screenshot below).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-21%20at%201.31.53%20PM.png?version=1&modificationDate=1601541479490&api=v2)
+
+#### DataSet Uploader
+
+In DataSet Uploader the mechanism is very similar to one in openBIS.
+When you want to add Ad Hoc Vocabulary Term, click on a plus button (see
+picture below).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-21%20at%203.45.58%20PM.png?version=1&modificationDate=1601541479488&api=v2)
+
+After clicking on plus button, a dialog appears (again, very similar to
+on in openBIS).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-21%20at%203.48.46%20PM.png?version=1&modificationDate=1601541479485&api=v2)
+
+Ad Hoc Vocabulary Terms can be easily recognize - they are shown in
+*italic grey* (see screenshot below).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-21%20at%203.50.02%20PM.png?version=1&modificationDate=1601541479483&api=v2)
+
+### Approving Ad Hoc Vocabulary Terms
+
+Power User can approve Ad Hoc Vocabulary Terms. Approving changes the Ad
+Hoc Term into regular one - it won't be shown in *italic grey* anymore,
+the maintenance task won't be able to delete it.
+
+To approve Ad Hoc Vocabulary Term select `Vocabulary -> Browse` from
+`Administration` menu (see screenshot below).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-22%20at%208.50.50%20AM.png?version=1&modificationDate=1601541479480&api=v2)
+
+Then select the vocabulary from the list. The new tab with all the terms
+available in chosen vocabulary will be shown. In column `Approved?` you
+can see weather term is Ad Hoc (not approved) or not (see the
+screenshot).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-22%20at%208.53.38%20AM.png?version=1&modificationDate=1601541479478&api=v2)
+
+You can select all the terms you want to approve (it is possible to
+select more than one using command key on Mac, or control key on Windows
+and Linux) and simply click on "Approve" button. You will see last
+confirmation dialog before operation will be performed (see the picture
+below).
+
+![](/download/attachments/53746007/Screen%20shot%202011-06-22%20at%208.54.04%20AM.png?version=1&modificationDate=1601541479475&api=v2)
+
+### Maintenance Task
+
+There is a maintenance task which deletes unused Ad Hoc Vocabulary Terms
+older than configured number of days. It can be configured in openBIS
+`service.properties`.
+
+**service.properties**
+
+    # --------------------------------------------------------------------------------------------------
+    # Maintenance task removing old and unused Ad Hoc Vocabulary Terms
+    # --------------------------------------------------------------------------------------------------
+    # The directory to watch for incoming data.
+    ad-hoc-terms-remove-task.class = ch.systemsx.cisd.openbis.generic.server.task.RemoveUnusedUnofficialTermsMaintenanceTask
+    ad-hoc-terms-remove-task.interval = 3600
+    ad-hoc-terms-remove-task.older-than-days = 7
+
+Make sure, that the task is configured on maintenance-plugins list.
+
+### Configuration
+
+By default, Ad Hoc Vocabulary Terms are disabled. To enable it, you have
+to edit `web-client.properties` of openBIS and set
+`allow-adding-unofficial-terms` property to `true`.
+
+**web-client.properties**
+
+    # Should the feature of adding unofficial/ad-hoc terms to vocabularies be turned on.
+    # Default value: false 
+    allow-adding-unofficial-terms = true
+
+You should make sure, that in openBIS `service.properties` file you have
+specified path `web-client.properties` file.
+
+**service.properties**
+
+    # Name of the file that stores Web Client configuration
+    web-client-configuration-file = etc/web-client.properties
+
+-   No labels
+
+Overview
+
+Content Tools
+
+Apps
+
+-   Powered by [Atlassian
+    Confluence](https://www.atlassian.com/software/confluence) 8.2.0
+-   Printed by Atlassian Confluence 8.2.0
+-   [Report a bug](https://support.atlassian.com/confluence-server/)
+-   [Atlassian News](https://www.atlassian.com/company)
+
+[Atlassian](https://www.atlassian.com/)
+
+{"serverDuration": 140, "requestCorrelationId": "aeb9e54dda014b18"}