Database Export Tool

Use the Export Data option in CSM Administrator to export a selected CSM database to a compressed Cherwell Archive Repository (.czar) file.

You can export:

  • A single Business Object.
  • An entire system (full backup).
  • A log file to capture the details of the database export.

When exporting an entire system, define what to export:

  • All Data: Exports all SQL Server tables (example: Field names and sizes) and data. Use this option to create a full backup .czar of an entire CSM system.

    When using this option, select to exclude the following data so that the .czar file size is smaller:

    • Attachments: Exports the attachment table but not the attachment data within the table. Use this option to create a .czar file to troubleshoot problems that are not related to file attachments.
    • Automation data: Exports the events and scheduler tables, but not the data within the tables. Use this option to create a .czar file to troubleshoot problems that are not related to Automation Processes or scheduled items.
    • Encrypted fields and protected stored values: Exports field data, but not encrypted fields or protected stored values. Use this option to exclude sensitive data from a .czar file. Note that a .czar file will never contain decrypted data, even if encrypted fields are exported. If the data will be provided to the CSM support team, we recommend excluding encrypted fields and protected stored values from database exports. Encryption keys are not included in any database exports; we recommend exporting keys from the Server Manager and storing them in a secure location.
  • Table Structure Only: Exports all SQL Server tables without any data. Use this option to create a .czar file that excludes confidential company data.
  • Table Structure and Lookup Tables: Exports SQL Server tables for all Major and Supporting Objects, as well as tables and data for Lookup Objects (validation tables). Use this to create a .czar file that excludes confidential data but includes values from Lookup tables (because typically, Lookup tables do not contain confidential data and can be used to troubleshoot problems with validation and relationships).

To export a single Business Object:

  1. In the CSM Administrator window, select the Database category, and then select the Export Data task.

    The Export Data window opens.

  2. Select the Export Single Business Object option.

    The window changes to select a single Business Object.

  3. Select the Business Object to export.
  4. Select the Exclude encrypted fields and protected stored values check box to exclude encrypted fields and protected stored values from the export. We recommend excluding encrypted fields and protected stored values if the data will be provided to the CSM support team.
  5. (Optional) Select the Logging check box to generate and export a log file (.log) that captures the details of the export. This file is named the same and exported to the same location as the .czar file.
  6. In the File field, provide a name for the .czar file (example: Incident_Nov2020), and then specify a location. Provide a location or select the ellipsis button Ellipses Button to navigate to a location.

  7. Select OK.

To export a system:

  1. In the CSM Administrator window, select the Database category, and then select the Export Data task.

    The Export Data window opens.

  2. Select the Export Entire System check box.
  3. Select the Content to export:
    • Export All Data: Select this check box to export all tables and data, and then select to exclude the following so the file is smaller:
      • Exclude Attachments: Select this check box to exclude attachments.
      • Exclude automation data: Select this check box to exclude automation data.
      • Exclude encrypted fields: Select this check box to exclude encrypted fields.
    • Export Table Structure Only: Select this check box to export tables but no data.
    • Export Structure and Lookup Table Data: Select this check box to export Major and Supporting Business Object tables, as well as Lookup tables and Lookup table data.
  4. (Optional) Select the Logging check box to generate and export a log file (.log) that captures the details of the export. This file is named the same and exported to the same location as the .czar file.
  5. In the File field, provide a name for the .czar file (example: Backup_Nov2020), and then specify a location. Provide a location or select the ellipsis button to navigate to a location.

  6. Select OK.