Additional Information for Sophora Administrators
Information about command line parameters for DeskClients, status changes of documents, system documents and site structure.
Table of Contents
- Command Line Parameters for DeskClients
- DeskClient Customization
- State Changes of Documents
- System Documents
- Site Structure
- Configuring the "Open document by URL from clipboard" Action
Command Line Parameters for DeskClients
In the following, parameters that can be applied when starting the DeskClient using the command line are explained.
|-proxyhost=||Proxy host URL|
|-proxyport=||Proxy port number|
|-proxyuser=||Proxy login name|
|-extendedLogin=true|false||(De)activate the extended login mechanism (that is: creating a history of used accounts, showing a checkbox to enable auto-login, etc.)|
|-noAutoUpdate||Deactivate automatic software updates on start|
|-forceAutoUpdate||If a update is possible, the update starts without user confirmation|
|-noUpdateButton||Hide update button in login dialog|
|-swtTracking||Triggers debugging for SWT (for Sleak)|
|-updateUrl=||List of update site URLs (separated by semicolon)|
|-clientConfigurationFeatureId=||If there are unique configurable features within the DeskClient that exclude each other, a select box appears in advance to the login dialog. There the user has to pick one feature that should be used. To automatically invoke a certain feature you can specify its ID here. Note that once the DeskClient has been started with one feature this selection can not be undone.|
|-nl||Starts the DeskClient in the given language; currently supported languages are English "-nl en" and German "-nl de" (which is the default).|
|-autoSave=true|false||(De)activate the automatic save mechanism of the document editor.|
|-testMode||Starts the DeskClient in test mode which presents internal information in the UI like the hashcode or ID of certain objects. May be used for debugging.|
|-editorPageDisposeTimeout=||After this timeout (in seconds) not visible editor pages are disposed to free system resources. Default is 300 seconds.|
|-editorPageDisposeCheckInterval=||The interval (in seconds) to check for disposeable editor pages. Default is 30 seconds.|
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 type in the desired key value pairs (as given in the table above) 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). There append the desired key value pairs (as given in the table above) after the path to "deskclient.exe" in the field "target" and confirm with "Ok". Alternatively the parameters can be specified in the file "deskclient.ini" which is located in the same folder as the "deskclient.exe".
An example using the command line parameters within a Windows shortcut is given below:
C:\Programme\Sophora\DeskClient\deskclient.exe -user=smith -password=secret
Additional parameters are explained in the Eclipse documentation at http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.platform.doc.user/tasks/running_eclipse.htm.
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.
In Windows 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.
You can customize the login screen with an 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.
State Changes of Documents
The following table contains possible actions on documents and their resulting status. These are a document's change-over states. The exact state a document has changed to can be obtained by the DocumentChangedEvent that is sent by the Sophora server.
Except for the document types themselves, almost every configuration element within the administration view is handled by regular Sophora documents called system documents. The structure of such system documents is defined – as usual – via a CND and a corresponding node type configuration.
The distinctive feature of a system document compared to other documents in Sophora is that they are assigned to a certain mixin called sophora-mix:systemDocument. The assignment of this mixin to a node type configuration has the effect that an according menu item appears in the administration view. Beneath this menu item all system documents of this types will be outlined. Information like the system document's label and icon are read from the node type configuration as well. In addition such documents can be created and exported using the adminisitration view's context menu.
By selecting multiple system documents you can trigger repeating actions in one step. Note that this only works for documents of the same state but accross different types (of system documents).
Existing System Document Types
By default there are the following system documents:
- Paragraph styles
- Select values
- Image variants
(see section Configuring the Deskclients for details.)
The handling and usage of the site structure is primarily explained in the Sophora User Guide. This section gives some additional information intended for Sophora administrators.
Inheritance and Configuration within the Site Structure
Within the site structure different settings can be applied for websites and their structure nodes that are passed on to child structure nodes (on the "Configuration" tab of the site or structure node editor). For an individual structure node this inherited configuration may be overwritten. In turn, the overwritten configuration is passed on to its subordinate structure nodes where it might be replaced again. This behaviour might be useful concerning, for example, the availability of delivery channels or default settings of the proposal sections for follow-ups. Furthermore, the days until documents should go offline or should be archived can be set to a default value.
Consider the follwoing example in combination with the subsequent figure. There, checkboxes and colored fonts display the current state and the inherited state of six options which are either enabled or disabled.
- A green font expresses that an option is enabled.
- A red font tells you that an option is disabled.
- A marked checkbox says that this option has been explicitly enabled for this node.
- A filled checkbox states that the value is inherited from the parent node (and not modified at this node).
- An unmarked checkbox says that this option has been explicitly disabled for this node.
The combinations of font colors and checkbox states provide information about which settings are inherited and which have been defined at the current node.
Exporting the Structure
To export the structure use the context menu within the structure tree view as described below. There you can either export the entire structure from your repository or pick only a part of it.
- Select the root node of the (partial) structure you want to export and click right.
- Either select "Export" or "Export all".
- In the emerging dialog you have to choose the Sophora XML version you want to use as well as a target directory to export the structure to.
- Confirm with "Finish".
Within the property labeled "404-Error-Documents" in the configuration tab of a structure node you can define error documents which will be delivered when a document is not found under the configured structure node. As default this property inherits its values from parent structure nodes. The resulting site will have the status code 404 (Not Found).
To make this work properly with an apache, you have to make some additional configurations explained here.
The exported structure may be imported to another repository using the Sophora Importer.
Configuring the "Open document by URL from clipboard" Action
In Delivery you need to configure the preview template and a servlet in order to provide the Open document by URL from clipboard" action within the main menu. The required steps are described within the Sophora Delivery documentation.