Using CliniClue Xtend

The following instructions explain how to use CliniClue Xtend to convert local SNOMED CT content from the standard distribution format text files into ClueData. These steps allow that data to be available for browsing in CliniClue Xplore.

These steps assume that you have already:

CliniClue Xtend provides a 'wizard' style user-interface to walk you through the necessary configuration steps. Once the configuration is complete the entire process will run automatically. Depending on the size of the Extension being built and the speed of the computer, the process may take anything from a few minutes to several hours.

At the end of the process a zip archive containing the ClueData that has been built. This archive file can be distributed to CliniClue Xplore users. In order to use your ClueData files CliniClue Xplore users will need to have downloaded the ClueData for the referenced release of the SNOMED CT International Edition.

Two distinct processes are carried out by the software:

Import - The text distribution format files are read from the Source folder into an Intermediate Database.
Build - The Intermediate Database is processed to generate the required ClueData files in the ClueData folder.

During these processes the generated ClueData creates a library that is linked to, and depends on, the ClueData for a referenced release of the SNOMED CT International Edition.

Load CliniClue Xtend from the Start > All Programs menu.
If necessary use the 'Change' button to select the CicFactory folder location.
Click 'Next >>' The Edition selection options are now shown.
If the Edition you require is not in the drop-down list:
1. Click 'Add' The Edition Data Editor window will appear.
2. Enter the relevant information for your Edition.
3. Click 'Ok' to save the data.
Select the Edition you are building from the drop-down list.
Click 'Next >>' The build options are now shown
Select one of the build options In most cases, the 'Complete build' option should be chosen. Other options are incompletely supported in the current release but have been included to support diagnostic testing where required.
Click 'Next >>' The 'Source Data Folder' is now shown. The default option offered is usually correct. However, if you want to build an earlier version of the same Edition you can select this from the drop-down list.
Click 'Next >>' The locations of intermediate databases are now shown. Unless you selected a non-standard build option the setting for 'Current build Db' will be locked and is shown for information only. The 'Previous build Db' should be left blank. In future, the performance of large Extension builds may be enhanced by referring to the intermediate database used for the previous release build of this Edition. This option will also be required for build using incremental RF2 style files if/when these are adopted by the IHTSDO.
Click 'Next >>' The locations of intermediate referenced pre-existing Editions are now shown. The default option offered is usually correct. However, if required you can select other versions of these Editions from the drop-down lists.
Click 'Next >>' The location of the temporary ClueData build folder is now shown. This location is locked and is displayed for information only.
Click 'Next >>' CliniClue Xtend will now check the source files for any Subsets or Refsets. This is a fairly quick process usually taking less than a minute. When it is complete the screen that is displayed will depend on whether any Subsets or Refsets are present in the source data.
Select options for Subset or Refsets The options available depend on where any Subset or Refset files were present in the source data.
- If no Subsets or Refsets are present the only option offered is to specify a SubsetId for a default Language Subset.
- If Subsets or Refsets are present these can be viewed selected for inclusion in the build
1. Specify a SubsetId for an automatically generated Language Subset. If no Subsets or Refsets are present the only option offered is to specify a SubsetId for a default Language Subset. If there is a descriptions file but no language subset, CliniClue Xtend creates a 'virtual language subset' which allows CliniClue Xplore to correctly display terms for the language or dialect used in an Extension. Allocation of a SubsetId is optional and does not affect how CliniClue Xplore displays the data. However, if a SubsetId is allocated the intermediate database will correctly apply this to the members of the subset.
2. Select Subsets and Refsets for inclusion in the build Select a Subset/Refset in the list on the left to view its properties in the right hand frame. Individual Subset/Refsets are selected by checking the box in the list on the left. An entire group of Subset/Refsets can be included by checking the parent item (e.g. in 'Simple' in the illustration above).
Click 'Next >>' The ClueData Edition Header will now be displayed. The information in the Edition Header will be included in the ClueData for the new Edition. It is displayed by the CliniClue Xplore menu option 'Help/About Coding Scheme'. Update this information if it does not describe the Edition you are building correctly.
Click Import + Build to start processing the data.
The import process will run followed automatically by the build process. Progress bars and messages are displayed indicating the state of the process Note 1: In the current release some of the process names are cryptic - as long as the progress bar is moving assume all is well. Note 2: If the data provided is incomplete, inconsistent or contains data errors the build process may halt with an error message. If this happens check the error message (please save, copy or note down the message for future reference). Check the files in the source folder are complete (for example, a sct_concepts.txt without a sct_relationships.txt is an error) and that the files are not empty or obviously erroneous (note that distribution files are UTF8 text files which can be viewed in text editors like MS WordPad. If the cause of the error is not apparent please email a report to clue@cliniclue.com. Please provide as much information as possible about the circumstances of the error. Note 3: If errors occur or if you cancel processing the resulting ClueData will almost certainly be invalid.