Home A - Z
Page Index

FlowCast: Onboarding Guide

1. Purpose

FlowCast is a centralized service that automatically generates video demonstrations of application features.
It records real UI interactions from automation scripts and enriches them with narration, captions, and highlights.

FlowCast helps teams save time in preparing client demos, internal showcases, and QA evidence.

2. What FlowCast Provides

  • Automated execution of workflows from application test scripts.

  • Screen recording of real UI flows.

  • Narration and captions generated from mapped actions.

  • Feature highlighting (specific features or full workflows).

  • Video packaging and delivery via GitLab CI/CD artifacts or shareable links.

3. Responsibilities of Application Teams

To use FlowCast effectively, application teams must:

A. Automation Scripts

  • Provide UI automation scripts (Playwright, Cypress, or Selenium).

  • Scripts must:

    • Be stored in the shared GitLab repository.

    • Be tagged with feature names (e.g., login, checkout, profile_update).

    • Be stable and updated when the UI changes.

B. Narration Mapping

Maintain a mapping file of UI actions → narration text. Example:

click("#login-btn") => "Click the Login button"
fill("#email") => "Enter your email address"
fill("#password") => "Type your password"

C. Application Environment

  • Provide a test/staging environment accessible by FlowCast.

  • Supply demo/test accounts with proper permissions.

  • Ensure environment stability during recording runs.

D. Configuration

  • Register your application with FlowCast, including:

    • Base URL (test/staging).

    • Authentication flow details.

    • Available feature tags linked to automation scripts.

E. Review & Feedback

  • Review FlowCast-generated videos (especially in early stages).

  • Provide corrections or improvements for narration and terminology.

  • Report any mismatches between video content and expected workflow.

F. Security & Compliance

  • Use non-sensitive test data in recordings.

  • Ensure compliance with organizational video-sharing policies.

4. Workflow Overview

  1. Request: User requests → “Generate demo for Login and Profile Update.”

  2. Execution: FlowCast runs the corresponding automation scripts.

  3. Recording: FlowCast records UI flow, overlays captions/highlights, and generates narration.

  4. Delivery: Video is packaged and delivered as a GitLab artifact or link.

  5. Review: Application team validates video before client use.

5. Governance

  • FlowCast Service Team

    • Maintains the FlowCast platform.

    • Ensures pipeline integration and service reliability.

    • Provides onboarding and support.

  • Application Teams (Consumers)

    • Own automation scripts and narration mappings.

    • Ensure test environment readiness.

    • Review and validate FlowCast-generated demos.