Configuration Documents and Parameters

Standard Configuration Documents

Every Sophora installation has at least 5 different configuration documents. Depending on the add-ons you have purchased and the way in which you customised your system, there may be some more. Each of these additional configuration documents will be explained in the corresponding add-on documentation. In the following segment, we will introduce to you the five basic documents which you can find in the Administration view at System >> Configuration.

All configuration system documents consist of a dynamic table containing key value pairs. You can create, edit and remove key-value-pairs as in any dynamic table.

Abbreviations

This document is initially created by the server and stores all abbreviations that can be or already are used as a markup. It contains a dynamic table with key-value-pairs, where the key is the abbreviation and the value is the abbreviated. You can define key-value-pairs in the system document which can be used as a markup in the copytext later on. Abbreviation markups that you or another user has created directly within the copytext are also stored within this system document.

Languages

The markup languages are not configured in a system configuration document, but in a select value. The corresponding select value document is initially created by the server; it has the name Languages. Nonetheless, you can define another document to provide the markup language. To do so, the configuration parameter document.markup.languages.selectvalue.externalid has to refer to the new language document (see the configuration properties table for the copytext). However, language select value documents need to be defined as top level select values, with the international country code as the key and a meaningful name.

Configuration

The most important one is the Configuration document. It contains a dynamic table consisting of key-value-pairs. Within it, you can set general settings which will affect all DeskClients within your system, as well as some parameters concerning your Sophora server - which are usually adjusted in the server's sophora.properties file. You can find all valid server parameters in the corresponding article, all valid parameters for the DeskClient configuration a few paragraphs below.

It is necessary for any configuration change to take effect that you save and publish any adjustments you make in the configuration document. Some changes may even require you to restart your DeskClient or your server to become noticeable. Obviously, you also need to spell each key and value correctly, or you may experience no change in the DeskClients' behavior.

Note, that you can add, edit and delete the key value pairs as in any other dynamic table. Also, each key can get assigned multiple values.

Add a new configuration document:

You can always create a new configuration document using the context menu of the entry Configuration within the Administration view.

MimeTypes

You can configure mimetypes in this document. The usage of the document works analogous to the other configuration files.

Solr Relevance

This topic has its own article which you can find here.

Update-Keys

This document lists the keys of all internal Sophora updates performed on the Sophora server or cluster the client currently is connected to. Under most circumstances, this document can safely be ignored. However, if an update has not been performed properly, it may be helpful to check the list of update keys stored here.

Configuration Parameters

DeskClient Appearance and Functionality

Copytext Editor

Miscellaneous

Parameter	Description	Possible Values	Default
search.forceSolr	If the Solr search is enabled on the Sophora server and this key is assigned the value true, the DeskClient will perform a Solr search. This setting overrides the user preference Always run a JCR search.	true/false	false
search.modifiers	List of customised search modifiers. These modifiers are available below the Customised Search Modifiers toggle button within the Search view. Either XPath or Solr queries can be used as search modifiers. XPath queries are marked by a leading §, while Solr queries are marked by a leading $. When using a Solr query, the Solr field names must be used instead of the property names.	<Label>;<Search modifier> XPath example: All published videos;§[@sophora:state='published' and @jcr:primaryType='sophora-content-nt:video'] Solr example: All published videos;$[sophora_state_s:published AND primaryType_s:sophora-content-nt\:video]
showDeprecatedCategories	Defines, whether the deprecated (old) categories should be shown. If the value is false, the enhanced categories are shown instead.	true/false	true
textlinkNodeType	Document type of link documents	Valid node type, e.g. sophora-content-nt:link
textlinkUrlProperty	Name of the URL property within link documents	Property name, e.g. sophora:url
textlinkDeniedDocumentTypes	List of document types that cannot be referenced by text link in richtext and copytext.	Node type names, e.g. sophora-content-nt:filter, sophora-content-nt:image
tools	List of (external) tools that should appear in the DeskClient's Tools menu Tools may use special URIs to trigger actions in the DeskClient, e.g. to publish a document.	Name;URL Example: Channel overview;http://my.sophora-host:8082/system/channeloverview.jsp  Sending a telegram;https://mailer-service.de/userpages/10913/newsletter/?bc4d776fd428&action=telegram&

HTTPS Connection Configuration

The following system parameters for the configuration of a HTTPS connection to the Sophora server also apply to other Sophora components. For the DeskClient, these parameters must be configured in the deskclient.ini file (and not in the configuration document). These parameters must be set behind the -vmargs parameter, e.g.:

-vmargs
-Xmx1024m
-Dsophora.auth.trusted.certificates.only=true

Command Line Parameters for DeskClients

You can start the Sophora DeskClient with the following parameters. There are two ways to provide these parameters on the DeskClient's start-up:

Starting the DeskClient within Eclipse : Go to the Run Configuration of the DeskClient (either enter the Run menu or press Ctrl while clicking the DeskClient's entry in the list of runs), switch to the tab Arguments and enter the desired key value pairs (as given in the table below) in the field Program arguments. Confirm your modifications with Apply and hit Run to start the DeskClient with the new configuration.

Starting a DeskClient's stand-alone version (autonomous release): Create a shortcut to the file deskclient.exe and open its Properties menu (via the context menu). Append the desired key value pairs (as given in the table below) after the path to deskclient.exe in the field target and confirm with OK. The parameters can also be specified in the file deskclient.ini which is located in the same folder as the deskclient.exe (for Windows). Mac users need to open the context menu on their DeskClient.app file, select Show Package Contents, and navigate to Contents >> Eclipse to find the deskclient.ini.

This is an example for using the command line parameters within a Windows shortcut:

C:\Programme\Sophora\DeskClient\deskclient.exe -user=smith -password=secret

Additional parameters are explained in the Eclipse documentation.

Workspace and Configuration Directory

To separate the actual software and the user specific information (workspace and configuration), the parameters -data and -configuration can be used. Both parameters need a path to a certain directory as argument. These directories contain information like the postion and size of views, saved search runs or bookmarks. On a Windows computer, these parameters can be used in combination with environment variables, e.g. to point to the individual home directories of different users:

deskclient.exe -data %HOMEPATH%/sophora/data -configuration %HOMEPATH%/sophora/configuration

This behaviour can be enabled by creating a shortcut and handing in these parameters as explained in the section above.

DeskClient Customization

You can customize the login screen with your own image (e.g. a logo). It will be placed in the bottom right corner. You just have to put an image file named branding.png in the folder from which the DeskClient is started.

On Windows, it's normally the folder containing the deskclient.ini file.

On macOS, the image file must be placed in the /Contents/MacOS folder of the DeskClient app bundle. The image should be a transparent PNG not larger than 207 x 71 pixels.