To load/import column comments to RED from an external (.csv) file, select Tools > Table and Column Comments > Load Column Comments.

The Column Comments Import pop-up window is displayed:

  1. Type in the directory and file name of the source file or click the folder icon to navigate to the required directory.
  2. Select or de-select the check box of the required import options.
    • Only import comments from tables with a Business Display Name - This option enables you to only process columns in the import file that have a Business Display Name/Column Title defined. Clear the check box if you want to process all tables from your import file.
    • Only import comments that are not empty - This option enables you to only process columns that have comments defined in the import file. Clear the check box if you want to process all tables from your import file.   
    • Only import comments from End User Layer (EUL) tables - This option enables you to only process columns from tables in the import file that are visible to the end user. Clear the check box if you want to process all tables from your import file. The visibility of table objects to end users in RED are set in Tools > Options > Object Types > Object Type End User Setting, refer to Object End User Setting for details.   

    All the above options are selected by default.

  3. Click OK to proceed with the import. The Column Comments Import pop-up window displays the progress of your import. You can click Cancel to abort the process.

  4. Once the import process is completed, the pop-window displays the processing time and the number of comments copied to the metadata repository.

    After completing the import process, you can click Open Log File or Open Log File Folder to view the log file generated. Refer to Viewing the Import/Export Logs for details.

  5. Click Close to exit the pop-up window. The Results pane displays a summary about the comments imported and confirms the successful completion of the import.


  6. Use the Update Comments command from the context menu, to copy the comments from the metadata repository to the corresponding columns in the target database.

The Results pane displays the table(s) and column(s) that have added comments.

The table and column comments import/export only supports UTF-8 character encoded files. You also need to be aware of the following points, if you are going to use another tool other than Microsoft Excel 2013 to edit the comments:

  • The comment portion can be surrounded of double quotes.
  • Double quotes can be escaped within the comment by prefixing the quote with another quote.
  • Comma characters can be used within the comment, but only if the comment is inside double quotes.
  • Comments can span multiple lines, but only if the comment is inside double quotes.
  • Refer to Importing Comments from an External Source for details.



  • No labels