Taxo | Version 4

Administering Taxo

Get information about how to use and integrate Taxo in Sophora and inform yourself about the benefits of the add-on.

The input field "Taxonomies" can be used to enter multiple values which can be reused (tags). The values can be any text (words or phrases). This input field needs backing system documents (called taxonomy documents) in which all entered values are stored (see below). Stored values are proposed when text is entered.

Additionally each backing document stores a list of words that should not be used. This denylist prohibits phrases from being entered in the text field. To move a tag to this list you can use the context menu. The context menu of each tag also allows the removal of that tag from the backing document.

Configuration of the Input Field Taxonomies

  • Field Type: com.subshell.sophora.eclipse.tags.TagsFormField
  • Property type: String multiple

Each taxonomy document (system documents of type sophora-nt:enhancedTag) can be assigned to all or only to certain sites. If no valid site is checked, the document is considered to be valid for all sites.

When setting up a taxonomy field, you can select the taxonomy documents to use. Which taxonomy document is actually used is determined by the site assignment of the taxonomy document and the location of the Sophora document in which the taxonomy field is contained.

Verify that there is no overlap of valid sites in the selected taxonomy documents. If none or more than one taxonomy document is applicable to the field of a particular site, the input field will not work.

ParameterDescriptionRange of values
Taxonomy DocumentsThe documents were tags depending on the document location are stored for proposal.All existing taxonomy documents (system documents of the type sophora-nt:enhancedTag)

Exporting & Importing Taxonomy Documents

Taxonomy-documents can be exported and imported to base the tag list on an external source. Within the administration area editors with the required permission can select "Import..." or "Export..." to transfer lists.

Rebuilding a Taxonomy Document

A taxonomy document holds all used phrases entered in any document using this field. When this field is configured for the first time, you may already have values in stored documents for the configured property. But only when a document is saved the values will be stored in the corresponding taxonomy document. To fill the taxonomy document upfront with the values in existing documents you can trigger a rebuild of that document. A rebuild searches all documents which use the given taxonomy document and copies all values of the corresponding field into the taxonomy document.

A taxonomy document rebuild is trigger by a MBean via JMX. The MBean is located beyond com.subshell.sophora.RebuildTaxonomy. The MBean has two attributes and one operation. The operation rebuildDocument(externalId) starts a rebuild job for the given system document. If you don't know the external ID, you can look it up in the attribute Taxonomies. This attribute maps each external ID of a taxonomy document to its label.

The attribute RunningJobs shows all running rebuild jobs and their status. The rebuild has three steps: First find all documents which use the given taxonomy document, then extract existing values of these documents and afterwards adding all found values to the taxonomy document. The first and last step are relatively fast, but reading each document takes some time. Therefore the progress of processing the documents will be listed in the status text.

Last modified on 10/16/20

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.