Skip to main content

Configure the downloader

The desktop app stores local settings in JSON files. This makes runs repeatable.

Workflow overview​

The app follows a simple three-step workflow:

  • Export: Downloads data from the Firestore server and saves it as CSV files.
  • Analyze: Converts the saved CSV timestamps to Korea Standard Time (KST) and checks data coverage.
  • Excel: Generates the final researcher report in Excel (XLSX) based on the analyzed data.

How to use​

Step 1: Set up authentication (Credentials)​

  • Service key required: You need a Firebase Admin SDK service account JSON key file.
  • How to set it:
    1. On the workflow screen, find the Service Key section at the top.
    2. Click Choose file and select your local JSON key file.
    3. The app saves the file path in its local storage, so you usually do not need to select it again each time.

Step 2: Configure data export (Configuration)​

  • Participant ID:
    • Enter the participant ID you want to export.
    • This ID is used to create the output folder and to reference Firestore paths.
  • Date Range:
    • Select the time period you want to export.
    • Quick select: Use 1D, 1W, or 1M to automatically set a recent date range.
    • Custom: You can also manually set the start and end dates.

Step 3: Run the workflow (Run Workflow)​

You can run each step in order using the task cards, or run the full workflow.

  • Run Export: Click Run Export to start downloading data (you can check logs).
  • Run Analyze: Click Run Analyze to convert timestamps and generate analysis files (for example, _korea_time.csv).
  • Run Excel: Click Run Excel to generate the final Excel report.

Outputs​

  • Save location: By default, outputs are saved to: ~/.datacollection_researcher/output/<ParticipantID>/
  • Open folder: Click the Output Directory section in the app to open the folder directly in your file explorer.

Other menus​

  • Configuration tab: A screen for managing items like Participant Status.
  • Sync button: Refreshes the app when credentials or settings get out of sync.
  • Clear logs: If logs become too large, click the trash icon to delete logs for each step.

What you will do​

  • Find the local app folder
  • Set participantId, date range, and docRoot (optional)
  • Understand how timezone is handled in Analyze

Report issues​

Include:

  • The config files you used (remove secrets)
  • The exact error message
  • A screenshot of the error (if possible)