Import and export report definitions

You can easily import or export report definitions, when needed. This can help you create a local copy of your report configuration, share it with other users, or to quickly import previously backed up report definitions. Report definitions include the report name, description, the report query, and any tags associated with the report (if applicable). In addition to the WHERE clause of the report query (appearing in the Query field on the report detail page), the report query also includes the name of the entity set, the selected columns, and the name of the column used to sort the report. This information is stored in YAML format, used for writing configuration files, or other types of files, for storing or transmitting data. For example:

schemaVersion: 1

name: Sample Report

description: My sample report

query:

  FROM Devices

  WHERE AssetTag = '6XLUV8M8' OR AssetTag = 'C910G4BO'

  SELECT Name, AssetTag, EnrollmentStatus, ComplianceStatus, OperatingSystem.Name

  ORDER BY AgentHasBeenOpened ASC

tags:

  - devices

  - asset_tag

For more information about this format, visit https://www.redhat.com/en/topics/automation/what-is-yaml.

To import report definitions:

  1. On the Reports tab, in the top-right corner, choose Add New > Import Definition File.

  2. In the Import Report view that appears, click Browse and navigate to the file containing report definitions that you want to import. Then click Import Report.

    The report detail page appears on the Reports tab, showing the newly imported report. If any syntax issues are found in the import file, they appear on the page.

  3. Click Save to confirm that you want to import the report.

    KACE Cloud uses this step to validate the imported report. If there are any issues with the report, for example, if the report name is not unique, this is indicated on the page. If you do not save it, the report definitions are not imported into KACE Cloud.

To export report definitions:

  1. On the Reports tab, locate and click the tile of the report that you want to export.
  2. In the report detail view that appears, in the top-right corner, choose Edit > Export Definition File.

    The report definitions are exported to a YAML file and downloaded to your local Downloads directory.

    NOTE: In addition to exporting report definitions, you can also export the report contents to a CSV file. To do that, choose Edit > Export Data as CSV.

    If an imported report contains special characters, they may appear mangled in MS Excel. To prevent this from happening, create a new file in Excel, and on the Data tab, choose an option to import a text file.You also must specify a Comma as a Delimiter, and set File Origin to Unicode (UTF-8).