Instance-wide Configuration

For an instance of CKM, there are several configuration options.

These are options that apply to the CKM instance as a whole - note that individual users have many other options available from the Users/Options and Users/Configure Dashboard menu items.

General options

BOLD options need to be configured, normal ones are optional. Gray options are usually configured temporarily only.

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.
Note that individual users can choose to display the CKM frontend in any supported language (currently fully supported: English and German).
Possible options:

  • en
  • de
  • nb  
  • sl
  • ru (partly)

resource-display-localeIn 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-urlThe base url of the server for use in email templates, e.g. https://ckm.openehr.org/ckm

theme

The header style to use, used to configure the logo displayed on top and in the Known Issues and About tab (available from the About menu).
Possible options at the moment:

  • blue
  • gray
  • white-blue
  • white-gray
link-to-introductionA 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-faqA 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-involvedA 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).

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 holder of the copyright of resources in this instance as per overwrite-copyright. Needs to be configured if overwrite-copyright is always or empty

show-custom-schemes-first

If set and true, custom schemes are displayed before any other schemes in classification panels.

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-oid-for-template
root-oid-for-termset
root-oid-for-release-set

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. A html text or link to an external webpage.

privacy-policy

A link to a Privacy Policy page accessible on the web or a html text

code-of-conductAn additional/separate code of conduct. Often this is simply integrated into the terms-of-use. A html text or link to an external webpage.

email-style

As of CKM 1.16.0, 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 that 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

As of CKM 1.16.0, 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-emailA 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

An html text displayed on registration to ensure people know how to unregister if required.

add-about-text

Additional html text displayed on the About page of this CKM instance, e.g. "<a href="https://specifications.openehr.org" target="_blank">About openEHR specifications</a>"

resource-type-to-activate-in-resources-explorersThe resource type (archetype, template, termset) that will be activated on the left hand panels in CKM on loading.

Twitter configuration

  • twitter-name
  • twitter-consumer-key
  • twitter-access-key
  • twitter-consumer-secret
  • twitter-access-secret

The twitter configuration for twitter updates. If not configured, twittering is disabled.

The following triggers cause a tweet:

  • A resource (archetype, template, termset, release set) has been imported into CKM. (The resource must be within a publicly visible project)
  • A publicly visible resource (archetype, template, termset, release set) has been updated. This includes:
    • A normal upload of the resource
    • The publication of the resource
    • Changing the archetype id
    • Internalising a resource that was cached from remote
  • A resource is being published.
  • New project has been created (or is becoming visible).
  • A resource is moved from a private incubator to a public incubator or project, i.e. is becoming visible for everybody for the first time.
  • A new review round has been set up.
  • A new Change Request for a publicly visible resource has been created
  • A new discussion comment for a publicly visible resource has been created

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.

  • endpoint-url - The endpoint url for a Terminology Server with a FHIR-API that hosts the relevant code systems for code lookups in CKM.
  • username - The corresponding username with read rights to the Terminology Server, if any is required. (An AllowedList may be used as well)
  • password - The corresponding password if any
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.

  • endpoint-url - The endpoint url for a Terminology Server with a FHIR-API.
  • username - The corresponding username with read rights to the Terminology Server, if any is required. (An AllowedList may be used as well)
  • password - The corresponding password if any

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-registrationEnables or disables the ability to self-register as a new user in CKM. (true, false)
project-registrationEnables 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-rolesTrue to enable a project/incubator editor to delegate (assign/unassign) the editing roles for that project/incubator (editor, translation, terminology editor). Defaults to true, i.e. editors of a project/incubator can manage the editorship of the project/incubator. (true, false)
proxy-host / proxy-portIf running CKM behind a proxy, configure the proxy here for CKM.

git

  • repository-url
  • username-or-access-token
  • (password)

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
  - header
  - body

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 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 e.g. be Nehta, Norwegian, UK, ...

publisher-organisationThe organisation of this CKM. To be used in an archetype, e.g. openEHR Foundation or Nehta
publisher-namespaceThe namespace of the publisher, e.g. org.openEHR
licenceThe default licence for resources in this CKM, e.g. Creative Commons SA <https://creativecommons.org/licenses/by-sa/3.0/>
max-primary-assetsA max. number of primary assets in this CKM instance
resource-type-to-activate-in-resources-explorers

By default, the archetypes tabs are activated on loading on the left hand.

Can be any of archetype, template, termset.

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 where generic CKM emails stem from.
E.g. Clinical Knowledge Manager <do-not-reply@openehr.org>

notification.from

The email address where CKM notifications stem from. Usually the same mail.from

mail.smtp.host
mail.smtp.user
mail.smtp.password

The SMTP host used to send the emails. (Depending on server arrangements, this may just be localhost.
If required, a user and password to access the SMTP host