NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be undergoing maintenance Monday, July 22nd between 1700 ET and 1800 ET and will be unavailable during this period.
Please ensure all work is saved before said time.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised based on observations in the Dev tier, NCI project.

...

  1. Download the CDE match template. The filetype should be XLSM. (Start with a fresh template for each import.) 
  2. When opening your copy of the template, select Enable Macros

  3. Populate your file with information about the CDEs that you want to match.

    1. Prepare data for loading:
      1. Click the Source tab. 
      2. In the first row, enter the text in each column to be used for matching to existing CDEs in CDE Match. You may use any character as in a column name except single quote ('). 

      3. In subsequent rows, enter the permissible values or the value label, one per row below the column heading for each enumerated value. If the data element is non-enumerated, leave blank the cells below Row 1 for that column. If the permissible value is a local code (such as “1” or “2184”), enter the label/term for the code instead (such as “male”). 

      4. After filling in your column headings and permissible values, press Ctrl+t to transform content into the correct format for CDE Match. The macro creates a new Transform sheet containing one row for each unique combination of heading and permissible value. Columns with no rows beneath the header row on the Source sheet will only have one row on the Transform sheet. 
    2. Review the transformed data and revise for loading, if necessary. Click the Transform tab. The following table provides instructions for each column in that sheet:

      Column NameInstructions
      Batch UserEnter a batch user name in each row. You can provide any text in this column. The system CDE Match does not validate this column. 
      Batch NameEnter a batch name in each row. The combination of Batch User and Batch Name must be unique. All That is, all rows in your file may have the same combination, but that combination must not match any other combination already in caDSR.
      Batch SequenceThe macro specifies a unique sequence ID for each data element (each column from the Source sheet). Change "Batch Sequence" to "Seq ID" in the column heading. (The Transform macro creates a "Batch Sequence" column but the caDSR mapping file expects "Seq ID".)
      EntityThe macro specifies the name of the data element from the Source sheet.
      Perm ValThe macro specifies the permissible value from the Source sheet.
      User TipEnter a term or a phrase for the data element. CDE Match will use this term or phrase instead of the column heading from the Source sheet. The whole phrase is used, the system . CDE Match does not parse the words. This is useful if the column heading from the Source sheet is abbreviated or unclear.  For For each data element that has multiple permissible values, only the first row for that data element needs a User Tip.
      ContextsEnter a Context name to restrict the search for CDEs to only that Context.
      Preferred CDE IDIf you already know which CDE you prefer to use for this data element, enter the CDE Public ID and Version on the first row for the data element. If you enter a Preferred CDE, the system CDE Match does not try to match to other CDEs.
      Preferred CDE VersionIf you enter the CDE Public ID, also enter the Preferred CDE Version. 
      CommentsIgnore. 

      As you populate your file, keep in mind the following points:

      • You may add additional columns to the Transform tab for taking/keeping notes after the last template column, but the column names must be unique.
      • You can use your Delete key to clear the contents of one or more individual cells, but do not delete entire rows or columns. 

  4. Use the Microsoft Excel "Save As" feature to save the Transform sheet as CSV. A message appears indicating that the CSV file type does not support multiple sheets. Click OK to save only the active sheet.  
  5. Import the file into OneData:
    1. Log in as described in Logging In.
    2. From the Manage menu, select Manage Data. The Manage Data page appears. Select CDE Match. The CDE Match page appears. (For instructions on adding this page to your favorites, refer to Managing Favorites.)
    3. From the Import menu, select Conceptual Object Import
    4. Select the DS Import row and click Import (between Add New Mapping and Go To Data Manager). 
    5. Under Source Information, in the Import from File row, click Choose File. Navigate to and select your CSV file from your desktop. 
    6. Click Import at the bottom of the page. The system CDE Match displays a message with the status of your import. 
  6. Generate a list of CDEs that match your file:
    1. From the Manage menu, select Manage Data. The Manage Data page appears. Select CDE Match. The CDE Match page appears.
    2. Specify search criteria, such as all or part of your Batch Name. The format for the Date Last Modified field is MM/DD/YY (such as 03/05/22). 
    3. Click Apply Filter. Search results appear. 
    4. Select the checkbox for the rows you want to match. Select Run CDE Match. The system CDE Match starts checking all the input columns from your transform sheet against the caDSR CDEs for possible matches, including comparing the values from your transform sheet with permitted values for the CDEs. The process can take a while to run. The system CDE Match begins to fill in the number of PVs and the number of matched CDEs for each column in the input file. 
    5. You can navigate away from CDE Match and come back later to check whether it’s finished running. You can refresh the list of results by clicking Display Values.
  7. Review the CDEs that match your file. The following table describes the columns in the list of values: 
    Column NameDescription
    Batch UserThe Batch User name from your input file. You can use it to sort or filter results. 
    Batch NameThe Batch Name from your input file. You can use it to sort or filter results. 
    Seq IDThe Seq ID from your input file. When you ran the Transform macro, it had created the Seq ID column with a number representing each column in the Source tab of the import template. You can use the Seq ID to sort or filter results
    Date Last ModifiedThe last date a user modified this row. Initially, it is the date you (or another user) ran CDE Match for this row. 
    Column Name

    The column name from the Source tab in your copy of the template file. When attempting to find a matching CDE, the system CDE Match inspects the CDE fields:

    • CDE Long Name
    • Question Text(s)
    • Alternate Name(s)
    • Like Long Name 
    User TipYou can enter a A phrase or term for the system CDE Match to use as a user tip instead of the column name. There will be CDE Match saves only one entry for the 1st row in the transformed spreadsheet if the this column, even if this column is enumerated. The system CDE Match does not parse the phrase into individual terms. 
    # Source PVsNumber of PVs  or Labels into the Source Spreadsheet. These are used The number of permissible values or labels from the source spreadsheet. CDE Match uses these as a second level of matching matching  after matching the CDE by Column name Name or User Tips text. Only CDE Match compares only the best matching CDEs are compared to the source PVs/Labelspermissible values or labels. 
    ContextsOne or more contexts in the input file, if any. CDE match restricted the search to CDEs within these contexts
    # CDEs MatchedThe number of CDEs that were CDE Match identified as possibly matching the column column. 
    Preferred CDE NameThis will initially be blank unless a The name of the Preferred CDE was entered in the input file. After selecting “Set as Preferred” during the review process this column will contain the CDE name.
    Preferred CDE IDThe ID of the CDE in the input template, or the ID selected manually as a match.
    Preferred CDE VersionThe Version of the CDE in the input template, or the ID selected manually as a match.
    ContextsOne or more Context names (separated) that the match is restricted to. 
    , if any.
    Preferred CDE IDThe ID of the Preferred CDE in the input file, if any. 
    Preferred CDE VersionThe version of the Preferred CDE in the input file, if any. 
    Preferred CDE ContextThe context of the Preferred CDE in the input file, if any.
    # DECs MatchedThe number of DECs that CDE Match identified as possibly matching the column. 
    Preferred DEC IDThe ID of the Preferred DEC in the input file, if any. 
    Preferred DEC VerThe version of the Preferred CDE in the input file, if any. 
    Preferred DEC Long NameThe long name of the Preferred DEC in the input file, if any. 
    Preferred DEC Workflow StatusThe workflow status of the Preferred DEC in the input file, if any. 
    Preferred DEC ContextThe context of the Preferred DEC in the input file, if any. 
    CommentsComments in the input file, if any. 
    Sort DateThe modification date in an appropriate format for sorting. CommentsAny comments entered by the end user
  8. To edit values in the Batch User, Batch Name, User Tip, Contexts, Selected CDE, Selected DEC, and Comments columns, click the edit icon in the row you want to edit. A detail page appears for the selected item. In each text field, you may use any character except single quote ('). Make your changes and click Save. The system CDE Match confirms the change. Click Display Values. The list reappears with your changes. 

CDE Match has a command "Run DEC Match" . This will run command which runs the match algorithm on the imported files using just the CDE names, ignoring the permissible values. Click the "Matched DEC" node to see results.

...