Instance-wide Configuration
- Sebastian Garde
For any instance of CKM, there are several configuration options to customise the behaviour and look-and-feel of the Clinical Knowledge Manager instance. These are options that apply to the CKM instance as a whole.
Note that individual users have many other options available from the Tools/Options&Notifications menu item to customise their CKM experience.
General options
BOLD options need to be configured, normal ones are optional (or have a default that can remain unchanged in most instances). Gray options are usually configured temporarily only or are deprecated.
Parameter | Explanation |
|---|---|
locale | The server locale for this CKM instance. This is for example used to send emails in the appropriate language of the server and use log messages to e.g. commit, check-out etc in the correct language.
|
resource-display-locale | In some CKM instances it may be useful to have a preferred language for resources such as archetypes that is different to the locale language of the CKM instance - e.g. if CKM has not been translated into this language. |
base-url | The base url of the server for use in email templates, e.g. https://ckm.openehr.org/ckm |
theme | The theme to use for the CKM instance. Possible options at the moment:
|
link-to-introduction | A link to an external introduction to CKM, the URL used for the Help/Introduction/Help menu item, e.g. http://www.openehr.org/wiki/display/healthmod/Clinical+Knowledge+Manager |
link-to-faq | A link to a FAQ page, displayed as a Menu item in the Help menu if configured. E.g. http://www.openehr.org/wiki/display/healthmod/Frequently+Asked+Questions |
link-to-get-involved | A link to more information on how to get involved in CKM, displayed as a Menu item in the Help menu if configured. E.g. Get Involved! |
support-email | A support email address. Currently displayed in the Known Issues and About tab (available from the About menu) and during the registration process. |
notification | A short notification to be displayed in CKM at the bottom. This can e.g. be used to notify users of server downtime etc. |
delete-notification | false, true: If true an existing notification will be deleted. |
copyright-holder | If set, this is the default holder of the copyright of resources in this CKM instance. |
show-custom-schemes-first | If set and true, custom schemes are displayed before any other schemes in classification panels. Usually: false. |
initially-show-initiator-in-review-rounds-overview-grids | If set to true, the initiator of each review round is shown in the Review Round Overview Grids (Editor's Review Round on Dashboard & Reviews/Review Round Overview) by default. Defaults to false. (The field itself is always available and can thus be shown on demand by clicking on the grid header and selecting the appropriate column, however the requirement here is to have this field displayed by default in some CKMs.) |
activate-additional-view-by-default | For templates it is possible to configure an additional view via CKM's transform engine. This is displayed in addition to the simple form-based view displayed for each template on opening it in CKM. This setting controls whether the additional view is displayed by default (true) or the usual simple form-based view (false). Defaults to false. |
root-oid-for-archetype | Root OIDs for the OID registry for the various resource types. Need to be configured for CKM's OID registry functionality. Deprecated |
terms-of-use | Terms of use for this CKM instance. If configured will be displayed in CKM. HTML text or link to an external webpage. |
privacy-policy | A link to a Privacy Policy page accessible on the web or HTML text. |
code-of-conduct | An additional/separate code of conduct. Often this is simply integrated into the terms-of-use. HTML text or link to an external webpage. |
email-style | CKM supports the configuration of some limited CSS styling for emails sent out by CKM. The following is an example configuration to customize font and font color, link color and style, and the also configurable email-suffix to be displayed in a different colour: body, div, p, li, ul, span, * {font-family:tahoma,arial,helvetica,sans-serif; color:#555555;}
a {color:#567ebc; font-weight:bold;}
div.email-suffix, .email-suffix p {color:#A4A4A4; margin-top:15px;}Â Note: Not all email clients support all styling. This is beyond the control of CKM and it is therefore preferable that only simple styling is used for maximum display consistency across email clients. |
email-prefix | CKM supports a configurable prefix for all ckm generated emails. This enables the customer organisation to add for example the organisation name, logo etc. to the top of any email, thus making it potentially more likely that recipients just dismiss the email. Simple example configuration to display the CKM’s header logo at the top of the email with a little margin: <div style="margin-top: 10px; margin-bottom: 15px;">
<img src=\\"%{base-url}%/picture?assetname=logo-header">
</div> |
unregister-text-email | HTML text to be added to the bottom of most emails: While this can be used as postfix to any email, it should always include a direct link to unregister from this CKM instance, e.g.: If you wish to unsubscribe from this service, please follow this link: <a href="http://ckm.openehr.org/ckm/#unregister" >http://ckm.openehr.org/ckm/#unregister</a> |
unregister-text | HTML text displayed e.g. on registration to ensure people know how to unregister if required. Can be the same as the unregister-text-email configuration option or different. |
add-about-text | Additional HTML text displayed on the About page of this CKM instance, e.g. or additional details about this CKM instance. |
resource-type-to-activate-in-resources-explorers | The resource type (archetype, template, termset) that will be activated on the left hand panels in CKM on loading, in most CKM instances: archetype. |
Twitter configuration
| The twitter configuration for twitter updates. If not configured, twittering is disabled. The following triggers cause a tweet:
|
link-on-logo | The link on the logo in the top-left corner of CKM. |
ckm-abbreviation | The abbreviation used in emails, e.g. ckm -> Emails start with [ckm] |
ots-endpoint | Endpoint for the original Ocean Terminology Server (OTS) Webservice, e.g. "http://ots.oceaninformatics.com/OTS/OTSService.asmx?wsdl". If not configured a default will be used. |
code-lookup-fhir-endpoint | The endpoint for a Terminology Server with a FHIR-API that hosts the relevant code systems for code lookups in CKM.
|
external-value-sets-fhir-endpoint | The endpoint for an externally managed Terminology Server with a FHIR-API endpoint that hosts externally managed value sets foir use in CKM archetypes and templates.
|
opt-endpoint | Endpoint for the OPT generator Webservice. If not configured a default will be used. |
default-country | A default country. If configured this is preset in the user registration process. |
translator-registration | Enables or disables the registration as a translator. (true, false) |
self-registration | Enables or disables the ability to self-register as a new user in CKM. If true: Anybody can register to this CKM instance. If false: Accounts can only be created by administrators. |
project-registration | Enables or disables direct links to directly sign up for a project on registering with CKM. (true, false) |
restrict-resource-checkout | If true, the checkout of resources is restricted to appropriate project members, otherwise any registered user can checkout a resource. (true, false) |
can-editor-delegate-editor-roles | True to enable a project/incubator editor to delegate (assign/unassign) the editing roles for that project/incubator (editor, translation, terminology editor). |
proxy-host / proxy-port | If running CKM behind a proxy, configure the proxy here for CKM. |
git
| For new and updated resources to be exported to e.g. Github, a Git repository can be configured here. On import or update of a publicly visible resource, this is being exported to the configured repository. Usually, an access token is preferred. Username/password based authentification is being phased out for this purpose by Github. |
alert | An alert header text and an alert html body can be configured. This will be displayed once to each user that is already registered. Useful for e.g. notifying users about changes in CKM after an upgrade. |
editor-description | A short description used to describe an editor of this CKM instance or the CKM instance itself - e.g. "openEHR" for openEHR Editor or openEHR CKM. Could also be Norwegian, UK, ... |
publisher-organisation | The organisation of this CKM. To be used in an archetype, e.g. openEHR Foundation for the international CKM instance. |
publisher-namespace | The namespace of the publisher, e.g. org.openEHR |
licence | The default licence for resources in this CKM, e.g. Creative Commons SAÂ <https://creativecommons.org/licenses/by-sa/3.0/> |
max-primary-assets | A max. number of primary assets in this CKM instance. |
Icon configuration
Icon name | Description |
|---|---|
logo-header | The logo displayed top-left in CKM. Maximum height: 44px Should ideally be transparent. |
logo-big | The bigger logo displayed in the About menu. Max. width: ~250px Should ideally be transparent. |
ckm-favicon | The favicon used by CKM. (16x16, .ico) Should ideally be transparent. |
Email configuration
Parameter | Explanation |
|---|---|
mail.from | The email address used to send generic CKM emails from. |
notification.from | The email address used to send CKM notifications from. Usually the same as mail.from. |
mail.smtp.host | The SMTP host used to send the emails. (Depending on server arrangements, this may just be localhost. |
   Â