NIH | National Cancer Institute | NCI Wiki  


  1. Download the Model Import template. (Start with a fresh template for each import.) 

  2. Populate your file with information about the models that you want to import. The following table provides instructions for each column in the model import template. Currently, all columns are required:

    Column NameInstructionsLocation After Import
    DO NOT USELeave empty. None
    *Batch UserEnter 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 NameEnter a batch name in each row. The combination of Batch User and Batch Name must be unique.Model Import - Update grid
    *Seq IDSpecify a unique sequence ID in each row. (Not editable after import.)Model Element Characteristics Import detail ("SEQ_NBR")
    *Model NameSpecify the name for the model as assigned by the model owner. (Not editable after import.)Model Import - Update grid ("Imported Model Name")
    *Model IDSpecify the unique identifier for the model in caDSR.Model Import detail ("Model Based on Imported ID/Version")
    *Model VersionSpecify the version of the model that is registered in caDSR.Model Import detail ("Model Based on Imported ID/Version")
    Element Long NameSpecify the long name for the element in caDSR assigned by the model owner.

    Model Element Import grid and details

    *Element Physical NameSpecify 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.)Model Element Import grid and details
    Element DescriptionSpecify the model owner's description of the model element.Model Element Import grid and details
    Element TypeEach 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.Model Element Import grid ("Imported Element Type") and details
    Characteristic Long NameSpecify the long name of the characteristic. This column has no format restrictions.Model Element Characteristics Import grid and details 
    *Characteristic Physical NameSpecify 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.)Model Element Characteristics Import grid and details 
    Characteristic OrderSpecify 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.)Model Element Characteristics Import grid and details 
    Characteristic DescriptionSpecify the description of the characteristic.Model Element Characteristics Import grid ("Imported Definition")
    Characteristic TypeEach cell in this column has a drop-down list of all valid characteristic types (Column, Attribute, Property). Select a value from that list. Model Element Characteristics Import grid 
    Characteristic Min LengthSpecify the minimum length of the characteristic.Model Element Characteristics Import grid ("Min Length")
    *Characteristic Max LengthSpecify the maximum length of the characteristic.Model Element Characteristics Import grid and details ("Max Length")
    *Characteristic Data TypeSpecify the data type of the characteristic, such as integer or varchar(50).Model Element Characteristics Import grid and details ("Data Type")
    Characteristic UOMSpecify the unit of measure of the characteristic.Model Element Characteristics Import grid and details ("UOM")
    Characteristic Mandatory?Specify whether the characteristic is mandatory.Model Element Characteristics Import grid and details ("Mandatory (Y/N)") 
    Characteristic PK?Specify whether the characteristic is a primary key (or part of a primary key) for the element.Model Element Characteristics Import grid and details ("Primary Key?")
    Characteristic DefaultSpecify the default value for the characteristic.Model Element Characteristics Import grid and details ("Default Value") 
    CDE IDSpecify the CDE public ID.Model Element Characteristics Import grid and details ("Related CDE Public ID") 
    CDE VersionSpecify the CDE version number.Model Element Characteristics Import grid and details ("Related CDE Version")
    Element Mapping GroupSpecify the element mapping group, which is s high-level alignment of this model element with a common core semantics or meaning of the element. If CDEs are linked with the associated characteristics, the CDE semantics will be used for the characteristic, even if different than mapping group. (Not editable after import.)Model Element Import grid and details ("Imported Element Mapping Group")
    Characteristic FK?Specify whether the characteristic has a parent via foreign key association.Model Element Characteristics Import grid and details ("FK (Yes/No)")
    FK Element NameSpecify the parent element name, if the characteristic is a foreign key.Model Element Characteristics Import grid and details ("FK Element Physical Name")
    FK Element Characteristic NameSpecify the name of the foreign key element characteristic.Model Element Characteristics Import grid and details ("FK Element Characteristic Physical Name")
    CommentsEnter comments. (Not editable after import.)

    Model Element Characteristics Import 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 Logging In.
    2. From the Manage menu, select Manage Data. The Manage Data page appears. Select Model Import-Update. The Model Import-Update 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 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. 

      ColumnInformation
      Batch UserThe batch user name from the imported file. 
      Batch NameThe batch name from the imported file. 
      Date Last ModifiedThe date the model was imported or modified.
      Public IDThe unique caDSR model identifier. 
      VersionThe version of the existing model to be updated.
      Model Long NameThe long name for the model in caDSR assigned by the model owner.
      ContextThe context of the model. 
      Imported Model NameThe name of the the model from the imported file.
      Import StatusThe status of the model in the import process. Values include Validated and Updated.
      Validation MessageThe message generated by the Validate Model step.
    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 Import node. A grid appears with one row per model element.

      ColumnInformation
      Element Long NameThe long name for the Element in caDSR assigned by the model owner.
      Element Physical NameThe 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 TypeThe type of imported element, such as Table, from the imported file.
      Element TypeThe type of imported element, such as Table.
      Imported Element Mapping GroupThe element mapping group, from the imported file.
      Mapping Group NameThe name of the mapping group.
      Mapping Group DefinitionThe definition of the mapping group.
      Element DescriptionThe 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 Characteristics Import node. A grid appears with one row per model element characteristic.

      ColumnInformation
      Element Physical NameThe name of the element in the physical database. 
      Characteristic Long NameThe long name of the imported characteristic with no restrictions on the format.
      Characteristic Physical NameThe physical name of the imported characteristic.
      Characteristic TypeThe type of imported characteristic.
      Characteristic OrderThe order of imported characteristics.
      Min LengthThe minimum length of the imported characteristic. 
      Max LengthThe maximum length of the imported characteristic.
      Data TypeThe data type of the characteristic in the source. 
      UOMThe unit of measure for the imported characteristic.
      Mandatory (Y/N)Is the characteristic mandatory in the source?
      Default ValueThe default value of the imported characteristic.
      Related CDE Public IDThe related CDE public ID.
      Related CDE VersionThe related CDE version.
      Related CDE NameThe related CDE name. 
      Imported DefinitionThe definition of the imported characteristic.
      Related DEC NameThe related DEC name.
      Related DEC Public IDThe related DEC public ID.
      Related DEC VersionThe related DEC version.
      Related DEC ContextThe related DEC context.
      Date Last ModifiedThe 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 NameThe physical name of the foreign key element for the imported element.
      FK Element Characteristic Physical NameThe physical name of the foreign key element for the imported characteristic.
      Imported CommentsThe 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 triangle 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.  


Related topics:


  • No labels
Write a comment…