CKM Release 1.4.0

The release of CKM 1.4.0 features some major new additions to the functionality of CKM. It also improves on many details in CKM and fixes a number of bugs.

Most likely the biggest change in this release is CKM's support for v0 archetypes for in_development archetypes and the introduction of additional meta-data for each archetype, carried in its other_details field and managed by CKM where applicable. This includes a revision number, namespaces, unique ids, etc. As a consequence, it is now also possible to for example fork an archetype that was developed elsewhere as well as to internalise remote archetypes (i.e. that were cached previously).

 Other major new pieces of functionality include:

  • Ability to propose new archetypes as a normal user
  • Ability to search 'within' templates
  • An additional technical view for archetypes to show some of the more technical details of an archetype if and when required
  • Enhancement of CKM's webservices to support the serving of XML archetypes in addition to ADL.
  • A new CKM-wide discussion search functionality
  • Streamlined Sign-up process

 

Detailed List of Changes

Feature Requests

  • Backend-Service to recreate all cached OPTs
  • Add Norwegian translation and enable it
  • Capitalise first letter of menu and context menu items
  • Ability to Internalise remote archetype
  • Create technical view for archetypes
  • UserOverview should display the difference between undecided and non-reviewers
  • Add Printable View Top level for Archetypes and Templates
  • Language support for Walisian and GB and AR regional variants
  • For Forked archetypes, allow updating of references during import process
  • Add citation suggestion to the Share with colleague tab, restructure layout
  • Add XML archetype webservices
  • Add information about the value of signing up on the sign up form
  • Use Email address as a surrogate for the loginname when signing-in
  • Add honeypot field to CKM registration process
  • CKM-wide discussions search functionality
  • New archetype Proposals
  • Suggesting contributors: Various editors should be prefixed with a configurable string (editor description)
  • Only display accept copyright checkbox on import when necessary
  • Ability to redownload an archetype after initial upload
  • Internationalise CKM GitHub log messages
  • Option to activate a resource type other than archetypes in the left hand resource explorers
  • Ability to restrict the total number of primary assets in CKM
  • Active Branches Report: Add Ability to Delete All Unchanged branches
  • Norwegian Template Search Functionality Enhancements
  • Searching for the complete text of an other details field: Should indicate the field name in search result
  • Add link to GitHub repository if configured
  • When using the sign-up to a project link, the user shoud be presented with the open project on his first sign-in
  • Unrevoke a revoked review invitation
  • OPT Form View and Printable View should show magnitude constraints for DV_QUANTITY
  • Improve the comparison of Intervals
  • Add total of local and remote archetypes to the Archetype Statistics report
  • Enhancement of Other details
    • Archetype Mindmaps should have the same Description / Attribution structure
    • Update archetype change id services to work with revision numbering
    • Display Predecessor and Successor Archetype on Related Resource page
    • Display of Latest development vs latest published revision
    • Migration service to upgrade all unpublished archetypes to use the new revisioning rules
    • Introduce special handling when deprecating / undeprecating
    • Add various other_details fields as required per import type, per commit etc.
    • Add import types for archetypes
    • Republication of an archetype, esp. if it is a major revision
    • Rework Comparer to differentiate between Patch, Minor and Major version compatibility
    • Revision numbering
    • Add/adapt the REASSESS_* states
    • Add and remove review fields as required
    • Rework Display of resources with an additional Attribution Tab
  • Add configurable Subdomain icons

  • Normal users with roles in a few projects etc should be able to see their roles as well

  • When rejecting/deprecating an archetype (or other resource), the notification email should include the state in the header

  • Review reminder editor summary email: Add started status for started reviews

  • Better internationalisation of review reminder summary email to editors

  • Review Round direct link should be displayed for editors in the review round summary

  • Option to activate a resource type other than archetypes in the left hand resource explorers (CKM 1.3.2)
  • Resource search should support partial matches for all search types (CKM 1.3.2)
  • Use the Canonical Hash webservice to check the hash on import/update of archetype (CKM 1.3.2)
  • Backend capability to check canonical hashes of all archetypes (CKM 1.3.2)

 

Change Requests

  • Introduction to CKM tab should show the page at the link-to-introduction config

  • optional, mandatory and repeating should not be explained/detailed in the default case

  • Remove Simple HTML view for archetypes

  • Advanced Template Search Report should be available for non-signed-in users

  • The "Would you like to be a reviewer" question should be in a modal dialog instead of in the Dashboard

  • "null" instead of null returned for resource documentation resource cid if it is null

  • Deactivate the sign up CAPTCHA

  • Sub-professions and sub-health-domains should be opened up when updating user profile

  • If a project invitation is sent or a user is added to a project the emails should be from the initiator

  • Change Requests finetuning

  • Cardinality for Section/items should be 0..*, not 1..*

  • Internationalise CKM twitter messages

  • The potentially numerous Re:'s in the title of a discussion should be reduced to one in the notification email

  • Improvements to the Active branches report

  • Combine projects and Incubator accordion tabs into one

  • When updating an archetype with a change ID (RM Class change), the revision history should be refreshed, not the tab closed

  • Incorrect: Unknown RM type Real at path validation error

  • Don't store archetype-version

  • On check-out the ResourceMainPanel should not be closed but show the Revision History

  • Review Reminder email should have the "Decline ALL" option as well

  • Should prevent pushing to a live Git repository from a local machine

  • Review Round Summaries restricted to a project should list review rounds of referenced resources as well

  • Finetune Touch device detection for Win8

  • Should not show context menu on simple click for touchscreen when it is a grid with a checkbox selection model

  • Adapt OPT webservice client to accept the old standard style annotations again

  • Decrease Connection time out to OTS

  • Review Invitations Grid should not show invitation date and completion deadline by default if restricted to one review round

  • Do not display "Structure" of a top-level element explicitly

  • Import of reviews should be less verbose

  • Migration Service to migrate double-bracket style template paths to conventional paths

  • Should warn before translation only if pre-initial publication

  • When converting to plain text, e.g. when translating, need to retain some non-dangerous < > tags.

  • Deleting user photo service should now use the new mediaflux service to remove content completely

  • Move Jira issue collector to oceanEHR instance (CKM 1.3.2)

  • DV_Quantity should be xml serialised with the precision (CKM 1.3.2)

  • XMLSerialiser should also print the assumedValue of a DVOrdinal (CKM 1.3.2)

  • XMLSerialiser: CDuration should serialise the pattern (CKM 1.3.2)

 

Problem Reports

  • Show this tab on login checkbox takes incorrect amount of space and is cut off
  • Automatic removal of (en) for untranslated elements fails since GWT 2.7
  • Transform Engine should use cached OPT if available
  • Must not be able to import from remote if the only difference in the archetype id is v0 vs v1
  • Active Branches Report Panel may show unnecessaary scrollbar in Chrome
  • Dashboard portlets may show unnecessary scrollbars if CKM is loaded hidden
  • Chrome shows unnecessary double scroll bars in some tabs
  • Counting Change Requests fails
  • Generation of direct links to remote resources may fail under certain circumstances
  • Archetypes with certain fatal validation errors should not be allowed to be imported/updated
  • Client locale should be used for displaying the language name of a translation
  • Foreign characters in filenames cause the file to not be found after upload
  • Tabs are replaced with new lines for log messages and other plain-text sanitized texts
  • Correct incorrect mime type preventing searching of newly added/updated resources
  • Password Management doesn't work properly in latest Chrome version anymore
  • oi.termset.get / oi.template.get should not be used with an output
  • Login and logout does not refresh the Projects And Incubator AccordionPanel
  • Update unsecure jgit implementation
  • Registering termset with non-standard terminology fails
  • Deleting Termset from CKM should properly unregister the query from OTS as well
  • File Upload button is rendered poorly on Chrome/MAC
  • Duplicate ordinal values should be displayed
  • Reset Password email doesn't deal with non-ASCII characters properly
  • Registering a new termset should not create dummy null_0 entries in the dictionaries
  • Feedback textarea renders to wide for termset reviews
  • Terminology Review Summary fails to load if special question without comment on its term
  • Update contributors should use server locale for editor, translation & terminology editor suffix
  • If a template constrains more than one unit in a DV_QUANTITY, both constraints should be displayed properly
  • Publishing an archetype does not work if overwrite if-empty
  • Comparing DV_INTERVAL<DV_QUANTITY> with DV_QUANTITY fails
  • Change of Occurrence for SLOT are not listed in the Comparison Report
  • Decline review email header with double space
  • Termset Reviews cannot be initiated
  • Sign-up, login as admin, then create user, opens the same tab
  • Searching for a number fails
  • Call to service 'oi.terminology.terms.get' failed: Provider com.ctc.wstx.stax.WstxInputFactory not found
  • Direct link in Change Request notification doesn't work
  • On checkout and immediate download of a resource, the checked out resource should be exported, not the trunk
  • When searching for multiple words and more than one word is found in the extracted text, all words should be highlighted in the search result
  • Import from Remote Menu item should be visible from the openEHR site
  • Twitter icon in CKM menu may not be displayed
  • Remote subdomain check for existing archetypes needs to be more sophisticated
  • Archetype referenced by template may not be shown if archetype id has changed
  • Unconstrained DV_QUANTITY within a Choice: Datatype should be displayed properly in CKM
  • Loginnames with an ' in them get an error message on login
  • User-friendly explanation for search of resources is missing the states
  • Changing the archetype id to one that already exists in CKM should be prevented
  • Change archetype id process improvements
  • Bulk export may return latest version, even if latest published is requested
  • Committing a branch should be an atomic transaction including any status change as part of it
  • Assigning a resource from a private incubator to a project doesn't change the status from INITIAL TO DRAFT
  • Constraint on Precision of a DV_QUANTITY_ITEM could be an interval, but only upper limit is displayed in CKM
  • Operational templates should be stored with an xml mime type
  • Task Saved notification should not be in Times New Roman
  • Users should get a better feedback when requesting to join a project
  • When accepting a request to join a project, the editor should not go through the same process as for invitations
  • md5 webservice lookup should be more robust and not prevent checkout
  • Translation Reviews: Reviewer comments to special question are not displayed in sumary view for details node
  • Searching for apgar.v1 leads to exception within mediaflux
  • Link to private incubator template when signed in with insufficient rights should display error message
  • CReal's rm type must be Real not Double
  • Translation Review Keywords TextArea should not be editable in the Review Form

  • Translating an archetype: Auto-Focus should work better for some items

  • Comparing two dv-ordinals with duplicate values leads to phantom changes

  • Server locale is not honoured sufficiently if resource display locale is defined for determining the best language of an archetype

  • Submitting review feedback should be atomic and synchronised

  • A new review can be submitted twice under extraordinary circumstances, one is listed in review round 0

  • Review Form: Header values are too close to the Review textareas

  • Review feedback from previous review rounds looks wrong in actual invitation displayed

  • Null values for review comments results in NullPointerException on Review import into an email

  • Unnecessary attribution items in review summary simple view

  • Password Reset email has redundant $

  • Revision numbering: From rejected to an active pre-publication state assigns wrong number

  • Existing Linebreaks are doubled when picking up a started translation of an archetype in CKM

  • Defining General Special Questions shows unnecessary scrollbar

  • Review Overall Recommendation Combobox list may be too small

  • Cannot submit review feedback for phantom copyright field

  • Uploading a certain image as user photo causes endless loop

  • Add Norwegian translation and enable it

  • wbr's interpreted as plain text in archetype display

  • Termset Reviews cannot be initiated (CKM 1.3.2)
  • Release Set Exporter doesn't honour trailing whitespace for XML archetypes exported as Secondary assets (CKM 1.3.2)
  • Generic Transformer doesn't honour trailing whitespace for Archetype XML generation (CKM 1.3.2)
  • XML Serialiser must serialise the translations section (CKM 1.3.2)
  • DV_Ordinal value element of symbol must be serialised (CKM 1.3.2)
  • XMLSerialiser creates DV_INTERVAL<_DV_QUANTITY> (CKM 1.3.2)
  • Users Select Panel: If in window, button may be barely visible (CKM 1.3.2)
  • Select Users Advanced Tab: Only the first Subclass radio option is visible (CKM 1.3.2)
  • Select Users Advanced Tab: After search the Select Users button is only half visible (CKM 1.3.2)
  • XMLSerialiser should serialise assumed value of a DVCodedText (CKM 1.3.2)
  • DVDuration value may not be preserved properly for 0 values (CKM 1.3.2)
  • Deleting Termset from CKM should properly unregister the query from OTS as well (CKM 1.3.2)
  • Registering termset with non-standard terminology fails (CKM 1.3.2)

 

New Configuration

When upgrading, the following new configuration items may be set.

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.

 

V0 Migration Decision

After upgrading, any unpublished archetypes may be migrated to v0 archetypes and the other_details metadata added as required.

Depending on the CKM instance, this can be a bulk conversion. If not, each archetype will be updated individually.

Some may want to publish existing draft archetypes as v1 before continuing to work on them.

If a bulk conversion to v0 is desired, the following needs to be specified:

  • active-branch-handling: What to do if the archetype has an active branch. The active branch can be rejected or ignored when updating to the new revision numbering. Alternatively, the archetype can be skipped completely.
    (reject-active-branches, ignore-active-branches, skip-archetype)
  • log-message: The log message to be used for updated archetypes.