Skip to content

Export data

Mathias Stuhlmacher edited this page Sep 12, 2020 · 6 revisions

Export data

To support reporting all systems can be exported to spreadsheets (all systems in one spreadsheet) or markdown files (one file per system). You can separately decide for every system whether an export should take place or not which comes in handy for systems that are not "report-ready". Spreadsheet and markdown exporter are activated by default for every system.

System spreadsheet exporter (CSV)

  • Modules:
    • dfirtrack_main.exporter.spreadsheet.csv.system
    • dfirtrack_config.exporter.spreadsheet.system_exporter_spreadsheet_config_editor.system_exporter_spreadsheet_csv_config_view (configuration)
  • Version: v0.4.0 or above

What it is good for

As the name suggests, it creates a spreadsheet with all systems in CSV format.

How to use it

You can find the exporter in the systems list page at the button "Export CSV". Just press the button and the file will be created. The time to wait depends on the number of systems.

How to configure it

Simply press the button with the wrench right next to the exporter button. The configuration should be self-explanatory.

System spreadsheet exporter (XLS)

  • Modules:
    • dfirtrack_main.exporter.spreadsheet.xls.system
    • dfirtrack_config.exporter.spreadsheet.system_exporter_spreadsheet_config_editor.system_exporter_spreadsheet_xls_config_view (configuration)
  • Version: v0.4.0 or above

What it is good for

As the name suggests, it creates a spreadsheet with all systems in XLS format.

How to use it

You can find the exporter in the systems list page at the button "Export XLS". Just press the button and the file will be created. The time to wait depends on the number of systems.

How to configure it

Simply press the button with the wrench right next to the exporter button. The configuration should be self-explanatory.

In addition to the CSV exporter there is the possibility to export worksheets for some system attributes. This can be helpful if the target audience needs explanations (aka notes) about the attributes.

This is possible for:

  • Systemstatus
  • Analysisstatus
  • Reasons
  • Recommendations
  • Tags

Note that only separate worksheets are exported for the attributes that are also selected for export in the spreadsheet. Also there has to exist at least one instance of the attribute.

System markdown exporter

  • Modules:
    • dfirtrack_main.exporter.markdown.domainsorted.domainsorted
    • dfirtrack_main.exporter.markdown.systemsorted.systemsorted
    • dfirtrack_config.exporter.markdown.system_exporter_markdown_config_editor.system_exporter_markdown_config_view (configuration)
  • Version: v0.4.0 or above

What it is good for

This module exports plain text files in markdown format. This is either done sorted by domain or in a plain folder structure. Intention is to get a web-based project documentation for use with MkDocs.

How to use it

Just press the button and the markdown files will be created. There is no waiting time because the task is asynchronously executed by Q Cluster.

Note that with every execution of the exporter the whole systems directory will be cleaned and newly written. So adding system reports manually might be a bad idea. The necessary entries are also made in mkdocs.yml.

How to configure it

You can define one of both options (sorted by domain or system) in the configuration.

Simply press the button with the wrench right next to the exporter button. The configuration should be self-explanatory.

If Ansible was used to deploy DFIRTrack, an instance of markdown project is also created on the server.

Artifact spreadsheet exporter (XLS)

  • Modules:
    • dfirtrack_artifacts.exporter.spreadsheet.xls.artifact
    • dfirtrack_config.exporter.spreadsheet.artifact_exporter_spreadsheet_config_editor.artifact_exporter_spreadsheet_xls_config_view (configuration)
  • Version: v0.4.0 or above

What it is good for

As the name suggests, it creates a spreadsheet with all artifacts in XLS format.

How to use it

You can find the exporter in the artifacts list page at the button "Export XLS". Just press the button and the file will be created. The time to wait depends on the number of artifacts.

As a special feature, there is the option to only export artifacts that have a certain status. This should make it possible to export only those artifacts for which tasks still have to be processed.

How to configure it

Simply press the button with the wrench right next to the exporter button. The configuration should be self-explanatory.

There is the possibility to export worksheets for some artifact attributes. This can be helpful if the target audience needs explanations (aka notes) about the attributes.

This is possible for:

  • Artifactstatus
  • Artifacttype

Note that only separate worksheets are exported for the attributes that are also selected for export in the spreadsheet. Also there has to exist at least one instance of the attribute.