Skip to content

Quick start: location → source → scan → report

Goal: Set up a minimal data pipeline from a physical site to a viewable report.
Time: ~30–45 minutes (first time)
Requires: Engineer or admin authority (Sources, Scans, Reports). A running RD Analytics instance and at least one video file or stream to attach as a source.

Application home — start of the quick start workflow

This guide walks through the core workflow in the order shown in the application sidebar: Locations → Sources → Scans → Reports.

Tip

Merging is optional and used when you need to combine outputs from multiple scans. Skip it for this quick start.

Before you begin

  1. Sign in to RD Analytics (see Sign in and sign out).
  2. Confirm you see Locations, Sources, Scans, and Reports in the sidebar. If not, see User roles and access.
  3. Have a sample video file ready (or a configured stream URL), and note a name for your demo site (for example, Demo Site).

Step 1 — Create a location

A Location represents a physical or logical site (for example, a junction or facility). Sources are associated with locations.

  1. Open Locations in the sidebar.
  2. Create a new location (use Add or the create action on the list page).
  3. Enter a Name (for example, Demo Site) and fill required fields.
  4. Save the location.

Verify: The location appears in the Locations list and opens on the details page when selected.

Step 2 — Add a source and upload media

A Source is a video input tied to your deployment (file upload, stream, or type-specific configuration).

  1. Open Sources in the sidebar.
  2. Create a new source and assign it to the location from Step 1.
  3. Complete source-specific fields (type, name, connection details as required).
  4. If the source type uses file media, open the source Details page and use the Files tab (/sources/{id}?tab=files) to upload your sample video.
  5. Wait for upload and processing indicators to finish before continuing.

Verify: The source appears in the Sources list with the correct location. The Files tab shows your uploaded media when applicable.

Step 3 — Create and configure a scan

A Scan defines how video is analyzed (geometry, settings, and processing). You can open scans from the global Scans list or from a source.

  1. Open Scans in the sidebar (or open your source and select the Scans tab).
  2. Create a new scan linked to your source.
  3. Open the scan configuration workspace (/sources/{sourceId}/scans/{scanId}).
  4. Review Scan settings (schema-driven fields for your pipeline).
  5. In the Geometry editor, draw or adjust lines, areas, or zones on the video frame as required by your use case.
  6. Use the video player and timeline to confirm the frame and time range look correct.
  7. Set scan status to PENDING when configuration is ready, then start processing when prompted.

Verify: Scan status moves through QUEUED / PROCESSING to COMPLETED. If status is FAILED, open the error hint on the list or see Scan failed and video preview.

Step 4 — View and build a report

Reports display widgets (tables, charts, filters) backed by scan data.

  1. Open Reports in the sidebar.
  2. Create a new report or open an existing one.
  3. Open Report details (/reports/{id}/details) to set metadata (name, linked scans, and related options).
  4. Open the report view (/reports/{id}/view).
  5. Set filters and the time range if the report provides them.
  6. Select Apply to load widget data.
  7. To change layout: enter edit mode, add widgets by type (table, chart, image scan, and others), then Save the layout.

Verify: After Apply, data widgets show values for your completed scan and selected time range.

What you built

flowchart LR
  LOC[Location] --> SRC[Source]
  SRC --> SCAN[Scan]
  SCAN --> RPT[Report]
Entity Role in this guide
Location Where the source is deployed
Source Video input and media
Scan Analysis configuration and processing
Report Visualization and export of results

Next steps

Troubleshooting

Problem What to do
Missing sidebar items Check User roles and access
Upload fails Confirm disk space and file format; retry from Files tab
Scan stays FAILED See Scan failed and video preview
Report shows no data Confirm scan COMPLETED, time range includes processed data, then Apply
Yellow bar: real-time disconnected See Real-time connection disconnected