Skip to content

🌐 Web Component Documentation

✨ Introduction

The Web Component is a modern, user-friendly front-end interface designed to deliver a seamless and interactive experience. It enables users to efficiently manage tasks, configure system settings, monitor events, and handle integrations — all from a centralized dashboard.

Each page within the Web Component serves a dedicated purpose, ensuring that users can easily navigate, monitor, and control operations with confidence.

🔐 Login

The login page is the gateway to the system.

  • Enter your username and password.
  • Click Login to access the dashboard.

📋 Key Features

  • Task Management: Create, modify, and monitor tasks.
  • System Configuration: Manage agents, schedulers, calendars, and environment settings.
  • Event Monitoring: Get real-time insights into task execution, alerts, and system health.
  • User Management: Handle user roles and security access control.
  • Task Logs: Track task execution logs for troubleshooting.
  • Real-Time Log Streaming: Watch task execution output live as it happens via a persistent real-time connection. Stream logs from any running task directly in the browser.
  • Historical Log Viewer: Browse and search past task execution logs with stdout/stderr separation, full-text search, follow mode, and paginated retrieval (500 lines per page).
  • Adhoc Command Console: Execute one-off commands on individual agents or broadcast across the fleet. View real-time output from each agent in an aggregated dashboard.
  • AI Support Chatbot: Interact with an intelligent assistant to create tasks, update schedules, configure alerts, and manage the platform through natural conversation.

The navigation bar gives you quick access to major sections:

  • 📊 Dashboard (/)
  • 💼 Tasks & Groups (/tasks)
  • 🏃 Task Runs (/task-runs)
  • ⚙️ Scheduler (/scheduler)
  • 👥 Agents (/agents)
  • 🔌 Integrations (/integrations)
  • 🛡️ Administration (/admin) — Admin and Superadmin only
  • 🖥️ Adhoc Tasks (/adhoc) — Operator, Admin, and Superadmin only
  • 🤖 Support Bot (/support-bot) — Admin, Superadmin, or users with bot access enabled
  • 🏢 Client Portal (/client-portal) — Superadmin only

📊 Dashboard

The Dashboard page (/) provides a real-time overview of the entire platform.

Stat Cards

  • Tasks: Total, Active, and Inactive counts
  • Groups: Total, Active, and Inactive counts
  • Task Runs (24h): Success and Failed counts
  • Scheduler: Running / Degraded / Inactive status with health status, thread count, and connected worker count

Run Status Breakdown

  • Color-coded pills for each status (SUCCESS, RUNNING, FAILED, TERMINATED, etc.) with counts

Execution Charts

  • 7-Day Trend: Task execution trend (completed vs failed per day)
  • Today's Execution: Task executions grouped by time

Upcoming Schedules

  • Tasks scheduled within the next 60 minutes with live countdown timers
  • Shows task name, group, agent, and timezone

Connected Agents

  • Table showing agent name, host, status, queue, and pool
  • Warning when the Maintenance Agent is inactive

Recent Task Runs

  • Quick-glance table with task name, status, agent, started time, duration, and log viewer link

🎛️ Header Features

The header bar provides quick access to system-wide controls:

  • Instance Selector: Switch between your allowed instances from a searchable dropdown. Only instances granted by your administrator are visible.
  • Timezone Selector: View and change your timezone with a live clock display. All times in the UI are displayed in your selected timezone.
  • Scheduler Status: An amber "Scheduler offline" warning badge appears when the scheduler is inactive.
  • Notification Bell: View and dismiss system notifications. Forced notifications remain visible until resolved.
  • Theme Toggle: Switch between light and dark mode. Your preference is saved across sessions.
  • Session Management: View and manage your active sessions from the user menu. Each login creates a separate session, and you can revoke individual sessions independently.
  • User Menu: Access your profile settings, session management, and logout.

🛠️ Task Operations

Beyond basic definition, the system supports advanced task operations designed for operational flexibility and deep observability.

Ad-hoc Execution

The Ad-hoc Execution feature allows authorized users to bypass the standard schedule and trigger tasks immediately. This is a powerful tool for remediation and testing.

  • Permissions: Restricted to users with Superadmin,Admin, or Operator roles. Viewers cannot initiate ad-hoc runs.
  • Targeting Flexibility: Executions are not bound to their default hosts. You can opt to run a task against:
    • Its specific primary agent.
    • A selectable list of alternative agents.
    • The entire agent base, allowing for broad system-wide maintenance or broadcast commands.
  • Use Cases: immediate disaster recovery, validating a new task definition against a sandbox agent, or running system-wide diagnostics.

Task Log Viewing

The system implements a sophisticated log retrieval mechanism that provides visibility into distributed processes without requiring direct access to remote servers.

  • Retrieval Logic: When a log is requested, the system dynamically queries the specific execution agent.
    • Live Streaming: Task logs are streamed in real time for running tasks, displaying output as it is generated by the agent.
    • On-Demand Access: Completed task logs are retrieved on-demand with paginated navigation for efficient browsing.
  • Stream Separation: The viewer automatically parses and separates Standard Output (STDOUT) and Standard Error (STDERR), making it easier to distinguish between normal application flow and critical errors.
  • Limitations:
    • Agent Connectivity: Since logs are fetched directly from the source, the executing agent must be online and reachable to retrieve fresh logs.
    • Retention: While historical logs are accessible, they rely on the retention policies configured on the agent nodes.
    • Pagination: Log retrieval is paginated — default 500 lines per page (max 2000 lines per page). Navigate pages to view full logs.

🛡️ System Monitoring & Operations

Agent Management

The Agents section provides deep visibility into your execution infrastructure: - Status Monitoring: Real-time health checks (CPU, Memory, Uptime) for all connected agents. - Breached Agents: A dedicated view highlights agents that exceed the licensed agent count, displaying breach severity and agent details for license compliance management.

Scheduler Container Management

For advanced system administrators, the Scheduler interface allows direct control over the underlying container infrastructure: - Container Control: Start, stop, or restart scheduler containers directly from the UI. - Health Checks: Monitor the connectivity and service status of the scheduler's container environment.

Agent Detail Page

Clicking an agent from the Agents page opens the Agent Detail view (/agents/$agentName):

  • Resource Cards: CPU usage (with core count), Memory usage, Disk usage, and Uptime
  • Queue Information: Table of queues with pending task counts and idle/pending status
  • Task Statistics: Running/Success/Failed/Terminated counts with time range selector (24h, 7d, 30d)
  • Worker Identity: Agent name, process ID, pool type, max concurrency, host, and assigned queue
  • Actions: Restart agent or upgrade to a newer version (with confirmation dialog)

Breached Agents

The Agents page highlights agents that exceed the licensed agent count: - Breach Severity: Displays breach type and affected agents for license compliance management. - Agent Details: Shows agent name, host, and connection information for each breached agent.

Adhoc Tasks Page

The Adhoc Tasks page (/adhoc) allows operators and administrators to execute one-off commands on selected worker agents.

  • Compose & Execute: Enter a task name, shell command, and select target agents from a multi-select dropdown (only online agents are selectable).
  • Advanced Options: Configure stdout/stderr paths, max runtime (seconds), retry attempts, and run-as user.
  • Execution History: View past adhoc executions with search and time range filter. Expand any execution to see per-agent details including lifecycle chain, status, duration, and return code.
  • Access: Restricted to Operator, Admin, and Superadmin roles.

🛡️ Administration

Manage Users

User access is governed by a secure, role-based system. Administrators can create and manage users, assigning them to one of five distinct roles: - Superadmin: Highest-precedence role. Full access to all system features.Can manage all users and system settings. - Admin: Full access to all system features. - Operator: Can manage tasks and executions but cannot change system configurations. - User: Standard access for task viewing and limited interactions. - Viewer: Read-only access for monitoring purposes.

Manage Holiday Calendar

The system includes a robust calendar management module that directly influences task scheduling. - Holiday Management: Administrators can define holidays (single dates or ranges) to prevent task executions on specific non-working days. - Calendar Organization: Holidays are grouped by "Calendar Name," allowing for region-specific or team-specific schedules. - Integration: Changes to the holiday calendar trigger an automatic system refresh, ensuring the scheduler immediately respects the new blocked dates. - CSV Import: Bulk-import holiday entries from a CSV file (format: CalendarName,Reason,Date, date format YYYYMMDD). Duplicates are automatically skipped. - Delete Calendar: Remove an entire calendar and all its holiday entries with a single action.

💬 Tips for Users

  • Use the search bar to quickly find tasks or events.
  • Check the notification bell for system alerts and updates.
  • Customize your profile settings under the user menu.

✅ Summary

The Web Component empowers users to:

  • 🚀 Boost productivity through automation.
  • 🛡️ Improve system reliability with real-time monitoring.
  • 🧩 Extend functionality through integrations.

For any issues, refer to the Help section or contact your system administrator.

Frequently Asked Questions

Q: How do I access the EasyTask Web UI? A: Open your browser and navigate to the Web Component URL provided by your administrator. Enter your credentials on the login page.

Q: Can I view task execution logs in real time? A: Yes. The Web Component supports real-time log streaming for running tasks, allowing you to watch task execution output live in the browser. Completed task logs can be browsed with paginated retrieval (500 lines per page), stdout/stderr separation, and full-text search.

Q: What is the Adhoc Command Console? A: The Adhoc Command Console allows authorized users (Superadmin, Admin, or Operator roles) to execute one-off commands on individual agents or broadcast commands across the entire agent fleet, with real-time output aggregated in a dashboard.

Next Steps