NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Some of the features in caDSR II allow you to process content from a CSV file for bulk/batch importing to create new content. To view or use these features, log in as described in Logging In. These features need specially formatted templates that are attached to this wiki page

Panel
borderColorsilver
borderStylesolid
titleContents of This Page

Table of Contents

...

Tips for CDE Match

Run Transform

CDE Match transforms the Source input into one row per column and permissible value. The command to transform the Source input details is "opt"+"cmd"+"t".

See InstructionsPlease see the CDE Match Instructions document attached to this page. 
Special FeaturesCDE Match has a command "Run DEC Match". This will run the match algorithm on the imported files using just the CDE names, ignoring the permissible values. Click the "Matched DEC" node to see results.

Tips for DEC

...

Import and Update

Validating Lots of RowsSometimes, the system throws an error when attempting to validate more than 4 rows at a time. If that happens, try validating a few rows at a time.
DEC Import Required FieldsDEC Context, OC Concepts, Property Concepts and DEC CD Name/ID are required.
DEC Update Required FieldsThe DEC Context, DEC Public ID and Version are required for an Update. Any other columns that are populated will be treated as a change to the existing DEC, such as DEC CD, OC Concepts, Property Concepts.  Retired DECs cannot be updated. DEC WFS will be set to "DRAFT NEW".  
Known IssueIn release 1.53.4, if a duplicate DEC exists in another Context, you cannot bulk update the DEC. This will be fixed in future release.

Tips for DEC Match

DescriptionDEC match will run matching algorithms on the names in the template and display results in the "Matched DEC" node. You can select one of the DECs as "Preferred" and then download the results using the Delivery Options feature. 
Context Column

In the Context column, you can enter one or more contexts to search for matching DECs. Separate each DEC with a comma. Do not use spaces between DECs. For example:

XXX,CTEP,CCR

Tips for VD Imports

None at this time.

...

Import into Existing VDThe PV VM import is designed to import an enumeration into an existing Value Domain. PV/VMs can be created using existing VMs, or you can specify a new VM either with or without concept codes.
Specified VM DefinitionOptional Specified VM Definition is only used if the VM Type is "TEXT". The system will not throw an error but it won't be added to the VM.
Possible TimeoutValidate/Create will timeout if more than 5 minutes. Try batches of 100 until we can redesign the code. Watch.
VM ReuseIn a Text VM is specified and an existing VM with the exact name is found, it will be reused, even if it has concepts. The Validation message will indicate that existing VM is being used (need to fix spacing).

Tips for VM and Concept Match

After Importing

The results after importing are displayed one row per entry in the template. All results are kept in one database table, and without filtering results, they are all displayed in the same grid. So, after selecting "Go to Data Manager" or select "VM Match" again and filter for your batch name, then click "Apply Filter" to see just your results. 

To see the details of each row of matches, select "Edit" and select "VM Matched Results".

Use Cases

This feature can be used to match text strings entered into the template to:

  1. Existing caDSR Value Meanings (VM). caDSR VMs are already associated with Concepts
  2. Concepts from NCI Thesaurus or selected external terminologies

By selecting the appropriate command, end user can control the breadth of the matching algorithm.

Terms can be the Permissible Value if the value is text, or the name a variable. 

"User Tips" Column

The User Tips column is used by the system instead of the user supplied name. Sometimes the string from your form or data is not very representative of the its meaning, or consists of too many terms. If a "User Tip" is entered it is used instead of the imported name. User Tips can be entered through the front end or entered into the Template for each row and imported. 

Matched Results

The system indicates how many matches were found, why each row was considered a match, and the type of match that was run. Once a match is selected, it is displayed in the table of summary results by row.

Algorithm

Punctuation and spaces are removed. The "Rule Description" explains why each match was selected. The algorithm does not currently account for spelling errors.

"Run Match" VM Header Command

Select the rows to run the match algorithm against and select the "RUN MATCH" Command. Punctuation and spaces are removed. This command will try to find Exact or Like Matches using the caDSR Value Meaning (VM) preferred name for existing VMs, Concept Preferred name and Synonyms.

Click "VM Matched Results" to review recommended matches. If you do not find a desired match, select "Run VM Match Unrestricted".

"Run Match - VM Only" VM Header Command

This match searches only for existing VM names that are good matches to either the name of synonyms. It includes exact matches to the name or alternate VM names.

"Run VM - Match Unrestricted" 

VM Header Command

This match does not stop after finding exact matches. It extends the search to emphasize matches on the longest term in addition to "like" matches. 

"Run Match - Concepts Only" VM Header Command

This match searches only for Concepts by name and synonyms.

"Run Match Concepts Only - Unrestricted" VM Header Command

This match searches only for Concepts by name and synonyms the longest term in addition to more extensive matches. 

"Run Match - Terminology"

This matches allows the user to select a specific terminology to search for Concepts by name, synonyms or Concept Code.

"VM Matched Results"

If there is only one exact match, the system will automatically associate the matched result with the imported VM Name.

If there are multiple matches the user can select a row from "VM Matched Results" and select the "Set Preferred" command.

Multiple Concepts can be selected one at a time to post coordinate concepts. The system will appended the concept to the preferred concept string and generate the resulting name in the order the concepts are selected.  This can be viewed by selecting the Node with the Concept Name to view the selected items. The concepts and be reordered manually, but be sure to reorder the concept names, or clear the results, "Save" and then select concepts again from the matched results. 

Advancing through the imported VMs

When on the "VM Match Header" you can advance to the next VM in your imported file by using the "Rows x of xxx" arrows.

VM Match Header.Image Added

Column Order

The main column in VM Match is the VM Name. The processing is designed to find matching concepts based on the name and insert the Concept Name and Concept Code into the

grid. You can use Delivery Options to export the results and cut and past the contents of these columns into the PV/VM Import to simplify

table next to the VM NAME unless "User Tips" are entered. This order of the columns makes it easier to populate the PV/VM Template using cut and paste. 

Exporting results

Use the "Delivery Options" command to export the VM Match results into and Excel file. This simplifies creating the list of PV/VMs

to import into a

for PV/VM Import to populate and existing Value Domain.

Tips for Form Imports

Import from REDCap Data Dictionary FormatForm import uses a csv file format which is one row per Question. The template contains an Excel Macro so when opening the template to paste your content into, select "Enable Macros".

The Form Import Template is an xslm filetype and contains several Excel Macros, so please be sure to select "Enable Macros" when opening the template. This has been tested for use only on a Windows PC platform, not Mac laptops.

  1. Paste your form content into the template starting on Row 3, column E. At a minimum you must run the Macro "Standardize", see instructions below.
  2. If importing a PhenX REDCap Data Dictionary, you must run "Standardize", then "PhenxStandarize".
  3. "CombineZip" is optional, it automates copying form content into the template from one or more REDCap dictionary csv files. See instructions below. 
  4. Enter a Batch User, Batch Name and ensure that each row has a unique "Seq Id"
  5. Save the Form Template file as csv.
  6. Run Form Import from Manage>>Manage Data (or your bookmarked Favorites)
  7. Select "Import" from the toolbar, then "Conceptual Data Object" from the drop-down
  8. Select the checkbox next to "Form Import RedCAP v1" and select "Import" option from the toolbar (Between "Add New Mapping" and "Go To Data Manager")
  9. Select the "Choose File" and select the Form Import Template from our desktop that you have prepared for loading
  10. Change the last row in the table "Start at Row" from 2 → 3
  11. Select "Import" at the bottom of the Table
  12. After "Success" message, Select "Go to Data Manager" or Manage>>Manage Data>> Form Import (or from your bookmarked Favorites)
  13. Use the filter to search for your form, Click "Apply Filter"
  14. Select "Edit" for your form
  15. Select a "Context" from the dropdown
  16. Save
  17. Select "Parse Form"
  18. If successful, select "Validate Form"
  19. Review the results
  20. After successful Validate, Select "Create Form"
  21. Copy the Public Id and choose "Forms" from Manage>>Manage Data (or your bookmarked Favorites) to view the newly created form in caDSR
Running the Macros

There are 3 macros in the Excel Template. The Macro run key sequence can be viewed by selecting "Tools" from the Excel menu bar, then "Macro". 

Macro NameDescriptionExecute macro
CombineZipThis macro allows the user to import one or more forms in REDCap Data Dictionary format into the Form Template from a desktop folder.  This allows the user to run Form Import on a file containing multiple forms instead of one form import at a time. After choosing the keys as indicated in Execute Macro, select a Folder from your desktop and select the forms that you want to combine and import into the spreadsheet. Then run the "Standardize" macro, instructions below.Choose "Option" + "Command" + "w"
StandardizeEach row must have a Section Header and a few other details. This macro transforms content from REDCap structure into the structure suitable for caDSR Form Import.Choose "Control" + "Shift" + "x"
PhenxStandardizeFiles sent to us by PhenX team contained a row with Question Text "Record ID", and the Protocol ID was inserted into the Field Note Column. This macro removes the extra row for "Record ID", and clears the "Field Note" columnChoose "Control" + "Shift
Running the MacroChoose "Shift" + "CMD
" + "t"
Filling the template with form dataThe 1st row of headings are the REDCap DD headings. The 2nd row of headings match caDSR headings. Enter a short name in the Variable / Field Name, this can be used for matching to an existing CDE. In future release it will be added as a Question Short Name. Paste content into the template starting in the 3rd row. Please see the template for the mappings between the REDCap Data Dictionary column names and the caDSR form column names.
Form ContextREDCap does not have a column for Context. In Sprint 41 Context for all the form forms in the templates is selected after importing the template into caDSR.

...