NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added a link.

...

  1. Download the CDE match template from Templates and Instructions for Bulk Imports and Matching. 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. The Source sheet appears. 
      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 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. 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. 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 to help the match algorithm to find possible CDEs. CDE Match will use this term or phrase instead of the column heading from the Source sheet. The whole phrase is used. CDE Match does not parse the words. This is useful if the column heading from the Source sheet is abbreviated or unclear. 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, 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 sheet 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. CDE Match displays a message with the status of your import. 
  6. Generate a list of CDEs that match your file:
    1. Click Go to Manager. The CDE Match page reappears.
    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. The system displays one row per data element.
    4. Select the checkbox for the rows you want to match. Click Run CDE Match. 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. CDE Match begins to fill in the number of PVs and the number of matched CDEs for each column in the input file. If there is only one exact match, the system automatically associates the matched result with the imported data element.
    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. To run the match algorithm on the imported files using just the CDE names, ignoring the permissible values, click Run DEC Match.
  8. Review the CDEs that match your file. The following table describes the columns in the list of values: 
    Column NameDescription
    Batch UserInitially, the Batch User name from your input file. 
    Batch NameInitially, the Batch Name from your input file. 
    Seq IDThe Seq ID from your input file. When you ran the Transform macro, it had created a column with a number representing each column in the Source sheet of the import template. 
    Date Last ModifiedThe last date a user modified this row. Initially, it is the date you ran CDE Match. 
    Column Name

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

    • CDE Long Name
    • Question Text(s)
    • Alternate Name(s)
    • Like Long Name 
    User TipInitially, the user tip from the Source sheet: A phrase or term for CDE Match to use instead of the data element name from the Source sheet. CDE Match saves only one entry for this data element, even if it is enumerated. CDE Match does not parse the phrase into individual terms.
    # Source PVsThe number of permissible values or labels from the Source sheet. CDE Match uses these as a second level of matching  after matching the CDE by Column Name or User Tips text. CDE Match compares only the best matching CDEs to the source permissible values or labels. 
    ContextsOne or more contexts. CDE match restricts the search to CDEs within these contexts. Initially, the contexts from the input file, if any. 
    # CDEs MatchedThe number of CDEs that CDE Match identified as possibly matching the column. 
    Preferred CDE NameThe name of the Preferred CDE you specified in the input file, if any.
    Preferred CDE IDThe ID of the Preferred CDE you specified in the input file, if any. 
    Preferred CDE VersionThe version of the Preferred CDE you specified in the input file, if any. 
    Preferred CDE ContextThe context of the Preferred CDE you specified 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. 
    Preferred DEC VerThe version of the Preferred DEC.
    Preferred DEC Long NameThe long name of the Preferred DEC. 
    Preferred DEC Workflow StatusThe workflow status of the Preferred DEC. 
    Preferred DEC ContextThe context of the Preferred DEC. 
    CommentsInitially, the Comments from your input file, if any.
    Sort DateThe Date Last Modified in an appropriate format for sorting. 
  9. To edit values in the Batch User, Batch Name, User Tip, Contexts, Selected CDE, Selected DEC, and Comments columns:
    1. Click the edit icon in the row you want to edit. A detail page appears for the selected item.
    2. In each text field, you may use any character except single quote (').
    3. Make your changes and click Save. CDE Match confirms the change.
    4. To view the next data element from your imported file, click the Go to the next page icon (the triangle icon after Rows x of xxx)
    5. Click Display Values. The list reappears with your changes. 
  10. To review the matched CDEs and DECs, click the edit icon in the row you want to review. A detail page appears for the selected item. Click one of the nodes:
    • Matched CDEs:
      • Select a row and click Show PV
      • Select a row and click Set Preferred CDE.
    • Matched DECs:
      • Select a row and click Set Preferred DEC.

...