SaaS Documentation

SaaS Documentation Cover Image

SaaS Documentation (Visual Tools Layer)

The SaaS layer provides a visual, no-code workspace that enables teams to design, run, and govern AI-powered workflows without writing code. It is built for operators, business owners, product teams, and analysts who need to ship workflows quickly, validate outcomes with measurable criteria, and collaborate across teams under clear governance, auditability, and predictable cost controls.

This document is an execution-oriented SaaS manual. It explains: how the workspace is structured (orgs/projects/environments), how tasks are created and operated (runs, schedules, bulk jobs, retries), how outputs are validated and exported safely, and how teams can standardize and scale workflows from prototypes to reliable production operations.

While the SaaS layer is a no-code experience, it is not “toy tooling.” It is designed to be operated like a production system: clear roles, controlled change processes, incident-ready logs, predictable usage boundaries, and repeatable workflow definitions that can be versioned and shared across teams.

Key concepts used in this documentation:

  • Workspace: The top-level container for teams, billing, policies, and shared assets.
  • Organization (Org): A logical boundary inside the workspace (business unit, department, region).
  • Project: A scoped container for workflows, datasets, credentials, and exports.
  • Environment: Dev / Staging / Production separation to keep experiments away from mission-critical runs.
  • Task (Workflow): A reusable workflow definition: inputs + configuration + validation rules + outputs.
  • Run: A single execution instance of a task, producing outputs and logs.
  • Dataset: Structured inputs (CSV/JSON tables) attached to tasks for batch execution.
0. Quick Start (First Workflow in ~10 Minutes)

This section walks you through creating a production-ready workflow in a safe way. The goal is not merely to “get output,” but to establish the habits that keep workflows reliable: separation of environments, role assignment, validation rules, and cost awareness.

  1. Create a Project — Use a business-domain name (e.g., “Marketing Ops”, “Customer Support”, “Risk Review”). Add a short description: what the project produces, who owns it, and what “success” looks like.
  2. Set Environments — Create Dev for experimentation and Production for stable runs. Restrict Production edits to Admins when possible.
  3. Invite Team Members — Assign roles (Owner/Admin/Editor/Viewer). Use least privilege: Editors can run tasks; only Admins can change security or export policies.
  4. Create a Task from Template — Choose a template close to your goal (e.g., classification, extraction, summarization, content generation). Templates reduce misconfiguration by enforcing common patterns.
  5. Define Inputs and Output Format — Specify required input fields (e.g., title, description, tone). Define output fields (e.g., headline/body/CTA), plus formatting constraints (length, required keys, prohibited terms).
  6. Run a Test Execution — Use a small dataset (5–20 rows). Inspect results and logs. Confirm cost and latency are acceptable.
  7. Enable Validation Rules — Turn on schema checks and minimum quality checks to reduce manual cleanup and prevent “silent failures.”
  8. Export and Share — Export results to CSV/JSON and share a read-only link with stakeholders for feedback.
  9. Promote to Production — Clone the task from Dev to Production, lock critical settings, and schedule or trigger runs.

Practical tip: treat the first workflow as a “baseline definition.” Save it as version v1 and record 3–10 examples of acceptable outputs. This makes later iterations measurable and reduces subjective debates about “quality.”

1. Intended Users and Team Responsibilities

The SaaS layer is designed for teams that need outcomes and repeatability. It supports both non-developer operators and technical teams: business users can build and run workflows under guardrails, while engineering can productionize proven configurations later using APIs.

  • Operations: recurring runs, bulk processing, SOP-driven execution

  • Marketing/Growth: content generation, campaign analysis, localization

  • Support: standardized responses, knowledge workflows, QA review

  • Product: rapid experiments, feature validation, prototyping

  • Analysts: extraction, tagging, classification, structured outputs

  • Compliance/Security: policy controls, audit exports, access governance

  • Engineering: workflow hardening, automation, API migration

  • Leadership: cost visibility, KPI reporting, risk management

1.1 Ownership Model (Recommended)

For reliable outcomes, every task should have a clear owner and a defined review loop. A recommended model:

  • Task Owner: accountable for output correctness, prompt updates, and validation rules.
  • Operator: responsible for execution schedule, monitoring, and incident follow-up.
  • Approver: required for production-impacting changes (optional but recommended for critical workflows).
2. Product Scope and Design Goals

The SaaS layer exists to remove integration friction while preserving operational standards. It enables teams to achieve fast time-to-value without turning workflows into ungoverned “black boxes.” The system is designed to support: repeatability, collaboration, and safe scale.

  • Lower adoption barrier with guided setup, templates, and safe defaults

  • Reduce reliance on engineering for common AI workflow operations

  • Standardize repeatable workflows across teams with reusable assets

  • Improve output quality with validation rules and review-friendly views

  • Enable collaboration: shared assets, versioning, and approvals

  • Provide cost and quota guardrails: budgets, alerts, and usage transparency

  • Provide a clear migration path to API automation when scale requires it

  • Support enterprise governance: audit logs, role-based policies, traceability

2.1 What the SaaS Layer Is (and Is Not)
  • It is: a no-code operating environment for building and running production-grade workflows.
  • It is not: a “one-click magic button.” Output quality depends on clear inputs, templates, and validation.
  • It is: auditable and governable—designed for real operations.
  • It is not: a replacement for engineering when deep automation or custom integration is required.
3. Workspace Structure (Org / Project / Environment)

The workspace model is designed to prevent chaos as usage grows. It provides boundaries that make it possible to run hundreds of workflows across multiple teams without losing control over cost, security, or change management.

3.1 Organization

An Organization (Org) is a logical division for teams, departments, or regions. Orgs can enforce policies such as export restrictions, retention limits, or access constraints. Orgs also support reporting and budget boundaries.

3.2 Project

A Project contains workflows (tasks), datasets, credentials (where applicable), and exports. A project should map to a business domain or a product area rather than a single person. Projects make it easy to delegate ownership and maintain continuity when team membership changes.

3.3 Environment

Environments separate experimentation from stable operations. A recommended default is: Dev (rapid changes), Staging (final validation), and Production (locked configuration, scheduled runs).

Best practice: require approvals for production changes and keep export policies stricter in production. Use Dev for prompt experimentation and Staging for acceptance testing with representative data samples.

4. Dashboard (Monitoring, Cost, and Operational Health)

The dashboard provides a unified view across projects, workflows, and runs. It is designed for operational decision-making: what is running, what is failing, what is expensive, and what needs attention right now.

Core dashboard modules:

  • Usage: runs, throughput, volumes, success/failure breakdown

  • Cost: spend by project/task, burn rate, daily/weekly trends

  • Quota: remaining allowance, alert thresholds, policy ceilings

  • Quality: validation pass rate, common failures, anomaly signals

  • Health: latency, queue time, incidents, platform notices

  • Projects: owners, environments, status, tags, policy state

  • Audit Feed: changes, exports, role updates, approvals

  • Assets: templates, shared prompts, datasets, export configs

4.1 Recommended Operational Routine
  • Daily: check failures, cost spikes, and quota alerts; review “top failing tasks.”
  • Weekly: review spend by workflow; optimize prompts and batch sizes; identify workflows to standardize.
  • Monthly: confirm ownership, update retention policies, review export permissions, and renew approvals for critical workflows.
5. Workflow & Task Management (Create, Run, Schedule, Operate)

Tasks (workflows) are reusable execution definitions. The SaaS layer is designed around a lifecycle: design → validate → run → monitor → improve → standardize → scale.

5.1 Creating a Task

A task should be created with a clear purpose, input contract, output contract, and operational boundaries. Use templates when possible: they embed proven patterns and reduce configuration mistakes.

  • Create tasks from templates or from scratch

  • Define input fields, defaults, and required constraints

  • Define output fields and formatting expectations

  • Attach datasets and map columns to input fields

  • Enable validation rules and minimum quality gates

  • Configure runtime options (batch size, concurrency where applicable)

  • Define retry behavior for transient errors and partial failures

  • Save version snapshots for auditability and rollback

5.2 Running and Scheduling

Tasks can be executed as one-off runs, scheduled recurring jobs, or event-driven triggers (plan dependent). Every run is recorded with a configuration snapshot, operator identity, timestamps, and outcomes.

  • One-off runs: best for experiments, backfills, and manual operations.
  • Scheduled runs: best for recurring workflows (daily reports, content pipelines, maintenance tasks).
  • Triggered runs: best for integration scenarios where workflows respond to upstream events.
5.3 Bulk Operations

Bulk operations allow you to process large datasets without manual repetition. Operators can batch-run a task across thousands of items, monitor progress, retry failures only, and export results with consistent metadata.

5.4 Task Configuration Model (Executable Guidance)

Treat tasks like internal products. A well-defined task should include: a clear name, owner, inputs, outputs, validation rules, and operational limits. Example:

  • Task Name: “Ad Copy Generator — EN (Production)”
  • Owner: Growth Ops Lead
  • Inputs: product_name, features[], audience, compliance_rules, tone
  • Outputs: headline, body, CTA, disclaimers
  • Validation: required keys; max length; prohibited phrases; must include CTA
  • Operational Limits: max daily runs; max dataset size per run; export restrictions

This approach reduces operator error, improves handoff, and makes the workflow easier to migrate to API automation later.

6. Results, Evaluation, and Export

Output is only useful if it is reviewable, measurable, and exportable safely. The SaaS layer provides multiple views to help teams validate outputs at scale, detect systematic issues, and continuously improve workflow definitions.

  • Live result view during execution (progress + partial outputs)

  • Run history with filters (time range, status, owner, tags, versions)

  • Per-item trace view with input snapshot and full output payload

  • Failure analysis: error clusters, validation failures, retry outcomes

  • Export to CSV / JSON, including run metadata and version info

  • Role-based export control and optional redaction rules

  • Share read-only result views with expiration and audit logging

  • Quality checks: schema validation, constraints, and acceptance sampling

6.1 Output Contracts (Recommended)

Whenever possible, define outputs as structured objects rather than free-form text. Structured outputs are easier to validate, export, and integrate. Teams can enforce requirements such as “headline must be present” and “body must be under 200 characters.”

6.2 Evaluation Workflow (Practical Process)
  1. Baseline: collect representative inputs and define acceptable output examples.
  2. Validation: enforce schema and constraints; fail outputs that violate requirements.
  3. Sampling: review a percentage of outputs manually (higher for customer-facing workflows).
  4. Iteration: refine configuration and rerun on a controlled dataset.
  5. Promotion: only after consistent pass rate and stakeholder approval.
6.3 Export Governance (Recommended Defaults)
  • Restrict exports in Production to Admins or approved Operators.
  • Enable redaction for sensitive fields (PII, internal identifiers).
  • Record export events in audit logs (who exported, what, when, and destination).
7. Team, Roles, Permissions, and Auditability

The SaaS layer is built for collaboration and controlled operation. Access control is role-based and designed to prevent accidental edits, unsafe configuration changes, and unauthorized exports. All important actions are recorded in audit logs to support accountability and compliance.

  • Invite, remove, suspend members; manage workspace and project scopes

  • Role-based permissions (Owner / Admin / Editor / Viewer)

  • Environment-level restrictions (e.g., Production edits limited to Admins)

  • Optional approval workflows for production changes

  • Auditable actions: create/edit/run/export/role changes

  • Version history and rollback for workflows

  • Retention policies for logs and results (configurable by org)

  • Policy enforcement for data handling and exports

7.1 Suggested Role Definitions
  • Owner: full control (billing, policies, critical settings, governance).
  • Admin: manage projects, members, production workflows, and exports.
  • Editor: build workflows, run tasks, edit non-critical settings (typically Dev/Staging).
  • Viewer: read-only access to dashboards, runs, and results.
7.2 Audit Logs (What Is Recorded)

Audit logs are designed to provide traceability for security and operations. Typical recorded events include: task creation, configuration changes, approvals, run initiation/termination, export actions, permission changes, and policy updates.

Each audit event includes actor identity, timestamp, resource identifiers, action summary, and outcome status. Audit logs can be used to support incident reviews and compliance evidence requests.

8. Relationship with the API Layer (SaaS ↔ API)

The SaaS layer and the API layer share the same underlying capability stack. The SaaS layer is a UI-driven operating mode on top of the same endpoints and execution engine. This ensures consistency: what works in SaaS can be reproduced through API, and what is automated by API can be monitored and governed in SaaS.

Shared Core Capabilities

  • SaaS workflows and API integrations run on the same underlying services
  • Every SaaS action corresponds to real API calls and is recorded in run logs
  • Outputs can be reproduced by API using the same task configuration snapshot
  • Workflow definitions can be exported as API-ready payload templates

Switching Modes at Any Time

  • Start in SaaS for speed; migrate to API when automation is needed
  • Projects and environments align between SaaS and API usage
  • Engineering can productionize proven workflows with CI/CD practices
  • Teams can run SaaS and API in parallel during migration for output comparison
8.1 Migration Strategy (SaaS → API) — Recommended Process
  1. Prototype: build workflow in SaaS; validate outputs with small datasets.
  2. Harden: add validation rules, define output schema, set cost guardrails.
  3. Snapshot: export configuration and lock a version as the “source of truth.”
  4. Integrate: implement API calls in code using the exported configuration template.
  5. Parallel Run: compare API outputs to SaaS outputs; tune until consistent.
  6. Cutover: automate runs; keep SaaS for monitoring, governance, and ad-hoc operations.
9. Operational Safety, Governance, and Reliability

SaaS workflows should be operated with production discipline. The platform provides governance mechanisms that reduce risk and improve reliability, including controlled change, cost guardrails, policy enforcement, and traceability.

  • Change control: versioning, approvals, rollback capability

  • Cost guardrails: quotas, budgets, alerts, and burn-rate monitoring

  • Data handling controls: retention, redaction, export restrictions

  • Execution visibility: run logs, error traces, and audit feeds

  • Environment separation: protect production from experiments

  • Role-based restrictions on high-risk actions (exports, deletes, prod edits)

  • Operational playbooks: retry strategy, failure triage, escalation patterns

  • Compliance readiness: traceability, evidence logs, policy enforcement

9.1 Workflow Owner Checklist (Recommended)
  • Maintain a stable output schema and validation rules.
  • Monitor failure rates and top error categories weekly.
  • Review cost trends and update budgets/alerts as workflows scale.
  • Document acceptable output examples and update them when requirements change.
  • Use Dev/Staging for prompt changes; promote to Production only after acceptance checks.
9.2 Failure Handling & Retry Strategy

Not all failures should be retried. The platform distinguishes between transient errors (e.g., temporary timeouts) and deterministic failures (e.g., validation errors caused by missing inputs). A recommended approach:

  • Transient failure: retry with exponential backoff; limit max retries; alert if persistent.
  • Validation failure: do not retry until inputs or configuration are corrected.
  • Policy failure: require Admin review (export restrictions, quota ceilings, permission violations).
10. Support, Troubleshooting, and Escalation

If you encounter unexpected behavior (errors, inconsistent outputs, failed exports, permission issues, or performance degradation), start with run history and audit logs. Most issues can be resolved by confirming environment selection, quota status, and recent configuration changes.

10.1 Troubleshooting Checklist
  • Confirm you are operating in the correct environment (Dev/Staging/Production).
  • Check quota and budget status; review rate limit or policy violation indicators.
  • Inspect the specific run logs: inputs, task version, validation failures, and error details.
  • Review audit feed for recent changes (role updates, template edits, export policy modifications).
  • Retry only failed items after addressing deterministic causes (missing inputs, invalid mappings).
  • Confirm export permissions and redaction rules, especially in Production.
10.2 What to Include When Contacting Support

To accelerate investigation, include:

  • Workspace/Org: name or identifier
  • Project: name or identifier
  • Task ID / Task Name: plus version if applicable
  • Run ID: and timestamp range
  • Observed issue: expected vs actual behavior
  • Impact: number of items affected, whether production is blocked

Email: [email protected]