Run SafetyCulture Exporter

Download

1. Download the latest release of the SafetyCulture Exporter for your platform (Windows, macOS, or Linux).
   
2. Uncompress the file and move the extracted folder to where you want to store the SafetyCulture Exporter.
3. Proceed to configure the SafetyCulture Exporter.

Configure

1. Open your command-line application. This can be “PowerShell” for Windows and “Terminal” for macOS.

2. In your command line window, navigate to the location where you stored the SafetyCulture Exporter. Learn how to change directory or folder using command lines on Windows and macOS.

3. Run the following command line:
   ./safetyculture-exporter configure

   macOS users

   If you’re running macOS, you may come across the following error message: “safetyculture-exporter” cannot be opened because the developer cannot be verified. You can go to your Mac’s System Preferences > Security & Privacy > General settings to Allow Anyway, then retry the command line and click Open in the pop-up window.

   

   Windows Command Prompt users

   If you're using Windows Command Prompt rather than PowerShell, the command above may return an error. If you get an error around "." not being recognized, run .\safetyculture-exporter configure or safetyculture-exporter configure.

4. Proceed accordingly to open the configuration file:

   Windows PowerShell

   Run the following command line: notepad.exe safetyculture-exporter.yaml

   All other command-line applications

   Run the following command line: open safetyculture-exporter.yaml

   If you have any trouble opening the configuration file, return to the folder where you stored the SafetyCulture Exporter and double-click "safetyculture-exporter.yaml" to open it.

5. For a basic configuration, update the following fields:

   • access_token: Input your API token.
   • modified_after: Specify the date and time to start inspection exports from, based on the date inspections are modified, in Coordinated Universal Time (UTC). This field supports multiple date and time formats.

6. Save the changes to the configuration file. You can check out all configuration options on this page.

7. Proceed to run the SafetyCulture Exporter.

Configuration options

SafetyCulture Exporter relies on configuration files to determine what and where to export data and from which account's perspective.

When you download and configure the SafetyCulture Exporter for the first time, you will come across the following configuration options in the default "safetyculture-exporter.yaml" file:

access_token: ""
api:
  proxy_url: ""
  tls_cert: ""
  tls_skip_verify: false
  url: https://api.safetyculture.io
csv:
  max_rows_per_file: 1000000
db:
  connection_string: ""
  dialect: mysql
export:
  incremental: true
  inspection:
    archived: "false"
    completed: "true"
    included_inactive_items: false
    limit: 100
    skip_ids: []
    web_report_link: private
  media: false
  media_path: ./export/media/
  modified_after: ""
  path: ./export/
  site:
    include_deleted: false
    include_full_hierarchy: true
  tables: []
  template_ids: []
report:
  filename_convention: INSPECTION_TITLE
  format:
  - PDF
  preference_id: ""

The following table outlines each configuration field's purpose and accepted values:

Make sure you leave a space ( ) between each configuration field and its value. For example, take note of the space between : and " for access_token: "de8g4e68bg...3acb983b5211".

Available export options

The SafetyCulture Exporter can export the following data sets from your organization:

All data sets apart from inspection report and inspection JSON can be exported to CSV and SQL.

The format keys can be used to specify the data set tables to export. If you want to see the schema for each data set for CSV and SQL exports, run the following command line:
/.safetyculture-exporter schema

You can also check out each data set in detail to understand what each column's data means.

Please note that by default, the SafetyCulture Exporter exports all available data sets for CSV and SQL exports. However, you can customize the export.tables field in the configuration file to specify what you want to export.

Export data

Each time you run an export, remember to navigate to the directory or folder where you stored the SafetyCulture Exporter. Learn how to change directory or folder using command lines on Windows and macOS.

If you encounter an error when running the SafetyCulture Exporter, you may be able to refer to the error code and message to resolve the error yourself.

If you've made a mistake in the configuration file and want to reset your exports, you can delete the "export" folder in the SafetyCulture Exporter directory, then export again.

Export to CSV and SQL

• Run the following command line to export data to CSV:
  ./safetyculture-exporter csv
• Run the following command line to export data to SQL:
  ./safetyculture-exporter sql

If you want to export inspection media as well, update the flag for export.media to true in the configuration file. Alternatively, you can export with media by supplying the media flag in the command line. For example:

• CSV: ./safetyculture-exporter csv --export-media
• SQL: ./safetyculture-exporter sql --export-media

Export to PDF and Word

Please note that the format needs to be specified in the configuration file.

Run the following command line to export inspection reports:
./safetyculture-exporter report

Alternatively, you can export inspection reports to PDF or Word by supplying the format flag in the command line. Please note that both format flags need to be entered in uppercase: PDF and WORD. For example:

• PDF: ./safetyculture-exporter report --format PDF
• Word: ./safetyculture-exporter report --format WORD

Export to JSON

Run the following command line to export inspection JSON:
./safetyculture-exporter inspection-json

Report layouts

You can use the SafetyCulture API to search for report layouts in your organization and use their IDs for applying to inspection report exports. You can search either for report layouts available to all templates or report layouts only available to specific templates.

Search report layouts:

curl "https://api.safetyculture.io/preferences/search" -H "Authorization: Bearer {api_token}"

The above command returns JSON structured like this:

{
  "preferences": [{
    "id": "da5dceac-188a-4738-9550-a82b8801cef3",
    "label": "Example Layout 01",
    "is_global": true,
    "is_default": false
  },
  {
    "id": "93b6194c-c6b9-464b-a8dc-79fb6b48615c",
    "label": "Example Layout 02",
    "is_global": true,
    "is_default": false
  }]
}

Searching for a specific template's report layouts:

curl "https://api.safetyculture.io/preferences/search?template_id=<template_id>" -H "Authorization: Bearer {api_token}"