Skip to main content

Documentation Index

Fetch the complete documentation index at: https://arivu.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Automations Dashboard

Overview

Scheduled Automations allow you to run natural language queries automatically at specified intervals, with results delivered to your configured action endpoints. Perfect for generating recurring reports, monitoring dashboards, and automated data workflows.

Key Features

Cron-Based Scheduling

Flexible scheduling with standard cron expressions for precise timing.

Natural Language Queries

Convert natural language into automated SQL execution via the pipeline.

Multiple Actions

Route results to logs, email, or webhooks automatically.

Execution History

Track all automation runs with timestamps, status, and error logs.

Live Monitoring

Real-time logs and run history for each automation.

Enable/Disable Toggle

Pause automations without deleting them.

Creating an Automation

1

Configure Email (optional)

If you plan to deliver results via Email, configure SMTP settings first in Settings → Email Configuration and run a test email.Automations Dashboard
2

Navigate to Automations

From the Dashboard sidebar, click Automations.
3

Click Create

Click the Create button in the top right corner.
4

Enter Details

  • Name: A descriptive name for your automation (e.g., “Daily Sales Report”)
  • Query: Natural language description of what to query (e.g., “Show me total sales by region for the last 7 days”)
5

Set Schedule

Select a preset schedule or enter a custom cron expression:
  • Every hour: 0 * * * *
  • Daily at 9 AM: 0 9 * * *
  • Every Monday at 9 AM: 0 9 * * 1
  • Custom: Enter 5-part cron format
6

Choose Action

Select where results are delivered:
  • Log: Stored in automation history
  • Email: Sent to configured recipient
  • Webhook: POSTed to external endpoint
7

Save

Click Create to save and activate the automation.

Managing Automations

View Automation Details

Click on any automation card to open its detail page with:
  • Schedule Details: Cron expression, action type, status
  • Run History: Timestamps, duration, status for each execution
  • Live Logs: Real-time execution logs when you click “Run Now”
Automations Dashboard

Run Now

Manually trigger an automation immediately:
  1. Open the automation detail page
  2. Click the Play button (▶) at the top
  3. Watch live logs stream in real-time
  4. Results appear in Run History

Pause/Resume

Toggle an automation on/off without deleting:
  1. Click the Pause (⏸) or Play (▶) button on the card
  2. Automation will stop running on schedule until resumed

Edit or Delete

  • Edit: (Coming soon) Modify automation schedule, query, or action
  • Delete: Click the trash icon to permanently remove (no undo)

Action Types

Log

Results stored in automation history visible in the dashboard. Best for monitoring and analysis.

Email

Results formatted and emailed to configured recipients. Requires SMTP settings.

Webhook

Results POSTed to external endpoint as JSON. Integrate with external tools and APIs.

Scheduling Guide

Common Cron Patterns

DescriptionCron ExpressionExplanation
Every hour0 * * * *At minute 0 of every hour
Every 6 hours0 */6 * * *At midnight, 6 AM, 12 PM, 6 PM
Daily at 9 AM0 9 * * *09:00 every day
Daily at midnight0 0 * * *00:00 every day
Weekly (Monday 9 AM)0 9 * * 109:00 every Monday
Weekdays 9 AM0 9 * * 1-509:00 Mon-Fri
First of month 9 AM0 9 1 * *09:00 on the 1st
Every 15 minutes*/15 * * * *At :00, :15, :30, :45
Cron format: minute hour day month day-of-week. See crontab.guru for an interactive editor.

Error Handling

Automations include built-in error management:
  • Failed Query Execution: Logged with error message, automation continues on next schedule
  • Email Delivery Failure: Retried automatically, visible in logs
  • Webhook Timeout: Logged and retried based on configuration
  • Data Processing Error: Full stack trace captured in Run History
Check the Run History card for details on any failed executions.

Best Practices

Name Clearly

Use descriptive names that indicate the automation’s purpose and frequency.

Test Before Scheduling

Use “Run Now” to test queries before setting up recurring execution.

Monitor Results

Check Run History regularly to ensure automations are executing as expected.

Avoid Peak Hours

Schedule resource-intensive queries during off-peak times.

Document Queries

Use clear, specific natural language in query descriptions for future reference.

Backup Results

For critical automations, export results regularly as backup.

Limitations

  • Maximum 100 concurrent automations per instance
  • Queries must complete within 5 minutes
  • Email actions require SMTP configuration
  • Webhooks have 30-second timeout
  • Run history retained for 90 days

Troubleshooting

Automation Not Running

1

Check Status

Ensure the automation shows the green “Active” badge.
2

Verify Schedule

Confirm the cron expression matches your intended frequency.
3

Check Database Connection

Verify the active connection is still valid in your session.
4

Review Logs

Open the automation detail page and check Run History for error messages.

Query Execution Failed

1

Test Manually

Use “Run Now” to see the exact error in live logs.
2

Refine Query

If the natural language query is ambiguous, be more specific.
3

Validate Data

Ensure required tables and columns exist in your database.

Email Not Received

1

Configure SMTP

Go to Settings → Email Configuration and test your SMTP settings.
2

Check Logs

Look for “Email delivery failed” messages in Run History.
3

Verify Recipients

Confirm the email address is correctly configured.

Next Steps