Importing Updates to Registered Models

If you are a model owner, you can import updates to registered models:

1. Download the Model Import template from Templates and Instructions for Bulk Imports and Matching. (Start with a fresh template for each import.) 

2. Populate your copy of the template with information about the models that you want to import. The following table provides instructions for each column in the model import template. Column names with asterisks are required:

   Column Name	Instructions	Location After Import
   DO NOT USE	Leave empty.	None
   *Batch User	Enter a batch user name in each row. You can provide any text in this column. The system does not validate this column.	Model Import - Update grid
   *Batch Name	Enter a batch name in each row. The combination of Batch User and Batch Name must be unique.	Model Import - Update grid
   *Seq ID	Specify a unique sequence ID in each row in the batch. The system uses this ID during processing of the batch. (Not editable after import.)	Characteristic List detail ("SEQ_NBR")
   *Model Name	Specify the name for the model as assigned by the model owner. (Not editable after import.)	Model Import - Update grid ("Imported Model Name")
   *Model ID	Specify the unique identifier for the model in caDSR.	Model Import detail ("Model Based on Imported ID/Version")
   *Model Version	Specify the version of the model that is registered in caDSR.	Model Import detail ("Model Based on Imported ID/Version")
   Element Long Name	Specify the long name for the element in caDSR assigned by the model owner.	Element List grid and details
   *Element Physical Name	Specify the name of the element in the physical database. This is used in the mapping rules and for those needing to write programming language implementations of the rules. (Not editable after import.)	Element List grid and details
   Element Description	Specify the model owner's description of the model element.	Element List grid and details
   Element Type	Each cell in this column has a drop-down list of all valid element types (Table, Node, Class). Select an element type from the list. This usually depends on the type of model.	Element List grid ("Imported Element Type") and details
   Characteristic Long Name	Specify the long name of the characteristic. This column has no format restrictions.	Characteristic List grid and details
   *Characteristic Physical Name	Specify the physical name of the characteristic. This should be formatted exactly as it is in the database. This name will be used in the generated transformation rule. (Not editable after import.)	Characteristic List grid and details
   Characteristic Order	Specify the preferred order of the characteristic within the element, if you want to sort the list of characteristics by something other than alphabetical order. (Not editable after import.)	Characteristic List grid and details
   Characteristic Description	Specify the description of the characteristic.	Characteristic List grid ("Imported Definition")
   Characteristic Type	Each cell in this column has a drop-down list of all valid characteristic types (Column, Attribute, Property). Select a valid value from that list.	Characteristic List grid
   Characteristic Min Length	Specify the minimum length of the characteristic.	Characteristic List grid ("Min Length")
   Characteristic Max Length	Specify the maximum length of the characteristic.	Characteristic List grid and details ("Max Length")
   Characteristic Data Type	Specify the data type of the characteristic, such as integer or varchar(50).	Characteristic List grid and details ("Data Type")
   Characteristic UOM	Specify the unit of measure of the characteristic.	Characteristic List grid and details ("UOM")
   Characteristic Mandatory?	Specify one of the following values: Mandatory Not Mandatory Expected  If you specify Expected, also specify Null in the Characteristic Default column.	Characteristic List grid and details ("Mandatory")
   Characteristic PK?	Specify whether the characteristic is a primary key (or part of a primary key) for the element.	Characteristic List grid and details ("Primary Key?")
   Characteristic Default	Specify the default value for the characteristic.	Characteristic List grid and details ("Default Value")
   CDE ID	Specify the CDE public ID.	Characteristic List grid and details ("Related CDE Public ID")
   CDE Version	Specify the CDE version number.	Characteristic List grid and details ("Related CDE Version")
   Characteristic FK?	Specify whether the characteristic has a parent via foreign key association.	Characteristic List grid and details ("FK (Yes/No)")
   FK Element Name	Specify the parent element name, if the characteristic is a foreign key.	Characteristic List grid and details ("FK Element Physical Name")
   FK Element Characteristic Name	Specify the name of the foreign key element characteristic.	Characteristic List grid and details ("FK Element Characteristic Physical Name")
   Comments	Specify comments. (Not editable after import.)	Characteristic List grid and details ("Imported Comments")

   As you populate your file, keep in mind the following points:
   • You may add additional columns to your file 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. 

3. Use the Microsoft Excel "Save As" feature to save your copy of the template as CSV. 
4. Import the file into OneData:
   1. Log in as described in "caDSR II  Database System Account Setup" (https://service.cancer.gov/cadsr-curation?id=nci_ext_kb_article&sysparm_article=NCI-KB0015599). The home page appears. 

   2. From the Manage menu, select Manage Data. The Manage Data page appears. Select Model Import-Update. The Model Import-Update page appears.

      You can click  to add pages like this to your favorites, as described in "Favorites QR" (https://service.cancer.gov/cadsr-curation?id=nci_ext_kb_article&sysparm_article=NCI-KB0014994).

   3. From the Import menu, select Conceptual Object Import. 
   4. Select the Model Import v2 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 displays a message with the status of your import. 

5. To review the models, elements, and characteristics you have imported from your file:

   1. Click Go To Data Manager. The Model Import-Update 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. A grid appears with one row per model. For a description of each column, hover over the column name.

      View columns in the Model Import-Update grid

      Column	Information
      Batch User	The batch user name from the imported file.
      Batch Name	The batch name from the imported file.
      Date Last Modified	The date the model was imported or modified.
      Public ID	The unique caDSR model identifier.
      Version	The version of the existing model to be updated.
      Model Long Name	The long name for the model in caDSR assigned by the model owner.
      Context	The context of the model.
      Imported Model Name	The name of the the model from the imported file.
      Import Status	The status of the model in the import process. Values include Validated and Updated.
      Validation Message	The summary message generated by the Validate Model step. To view error details, continue navigating as described in the following steps.

   4. Click the (edit) icon in the row you want to view. A detail page appears for the selected model.

   5. Click the Model Element List node. A grid appears with one row per model element.

      View columns in the Model Element List grid

      Column	Information
      Element Long Name	The long name for the Element in caDSR assigned by the model owner.
      Element Physical Name	The name of the element in the physical database. This is used in the mapping rules and for those needing to write programming language implementations of the rules.
      Imported Element Type	The type of imported element, such as Table, from the imported file.
      Element Type	The type of imported element, such as Table.
      Validation Message	The summary message generated by the Validate Model step. To view error details, continue navigating as described in the following steps.
      Element Description	The description of the imported model.

   6. Click the edit icon in the row you want to view. A detail page appears for the selected model element.

   7. Click the Model Element Characteristic List node. A grid appears with one row per model element characteristic.

      View columns in the Model Element Characteristic List grid

      Column	Information
      Element Physical Name	The name of the element in the physical database.
      Characteristic Long Name	The long name of the imported characteristic with no restrictions on the format.
      Characteristic Physical Name	The physical name of the imported characteristic.
      Validation Message	The message generated by the Validate Model step.
      Characteristic Type	The type of imported characteristic.
      Characteristic Order	The order of imported characteristics.
      Min Length	The minimum length of the imported characteristic.
      Max Length	The maximum length of the imported characteristic.
      Data Type	The data type of the characteristic in the source.
      UOM	The unit of measure for the imported characteristic.
      Mandatory	Is the characteristic mandatory in the source?
      Default Value	The default value of the imported characteristic.
      Related CDE Public ID	The related CDE public ID.
      Related CDE Version	The related CDE version.
      Related CDE Name	The related CDE name.
      Imported Definition	The definition of the imported characteristic.
      Related DEC Name	The related DEC name.
      Related DEC Public ID	The related DEC public ID.
      Related DEC Version	The related DEC version.
      Related DEC Context	The related DEC context.
      Date Last Modified	The date the characteristic was imported or modified.
      Primary Key?	Is this the primary key of the imported characteristic?
      FK (Yes/No)	Is this a foreign key for the imported characteristic?
      FK Element Physical Name	The physical name of the foreign key element for the imported element.
      FK Element Characteristic Physical Name	The physical name of the foreign key element for the imported characteristic.
      Imported Comments	The comments from the imported file.

   8. Click the edit icon in the row you want to view. A detail page appears for the selected model element characteristic.
6. In each detail page, you have the following options:
   1. To view the next item from your imported file, click the Go to the next page icon (the icon after Rows x of xxx).
   2. To view the list of items again, click Display Values. 
   3. Make changes in editable fields and click Save. The system confirms the change.  

At this point, you can refresh the CDE associated with the updated model, as described in Refreshing the CDE Associated with a Model. 

Related topics:

• Exporting Items: https://service.cancer.gov/cadsr-curation?id=nci_ext_kb_article&sysparm_article=NCI-KB0014777
• Troubleshooting Imports