🧠 1. Introduction

What is JAutomations?

JAutomations Platform is a native Joomla automation engine that allows you to create event-driven workflows directly inside your website.

It enables you to:

• Automate repetitive tasks
• Connect Joomla with external systems
• Execute multi-step workflows
• Process jobs in the background

🎯 Core Concept

JAutomations is built around three main elements:

Trigger → Workflow → Actions

• Trigger: An event (e.g., article created)
• Workflow: A sequence of steps
• Actions: Executions (Email / Webhook / Telegram)

🚀 Why JAutomations?

• No need for external tools like Zapier or Make
• Full control inside Joomla
• High performance using Queue + CLI
• Extensible architecture for future integrations

⚙️ 2. Requirements

Before installation, ensure the following:

• Joomla 5.x or 6.x
• PHP 8.1 or higher
• Cron access on your server
• SMTP configured (optional, for email actions)

📦 3. Installation Guide

Step 1: Install the Package

1. Go to:
   Joomla Admin → System → Install → Extensions
2. Upload the package:
   pkg_jautomations_v1.0.0.zip
3. Click Install

Step 2: Verify Installation

Make sure the following are available:

• Component:
  👉 Components → JAutomations
• Plugin:
  👉 System - JAutomations

Step 3: Enable the Plugin

• Go to Plugins
• Search for: System - JAutomations
• Ensure it is Enabled

Step 4: Setup Cron (Important ⚠️)

Add a cron job on your server:

💡 Recommended: run every minute

🧩 4. First Automation (Quick Start)

🎯 Example: Send Telegram message when an article is published

Step 1: Create Automation

• Go to:
  👉 JAutomations → Automations
• Click New

Step 2: Configure Trigger

• Select Event:
  • Article Created
    or
  • Article Updated

Step 3: Add Step

• Choose Action:
  👉 Telegram Message

Step 4: Configure Action

• Bot Token
• Chat ID

• Message:

   

  New article published: {{title}}

   

Step 5: Save & Test

• Save the automation
• Create a new article
• Verify the Telegram message is sent

🔁 5. Understanding Workflows

Multi-Step Example

An automation can include:

1. Send Email
2. Delay (5 minutes)
3. Send Webhook

🔄 Execution Flow

• A job is added to the Queue
• Processed by the CLI worker
• Each step is logged

⏱️ 6. Queue & Background Processing

How it works

• Each execution is stored in:
  👉 execution_queue
• The CLI worker:
  • Reads jobs
  • Executes steps
  • Updates status

🧠 Why Queue matters

• Prevents website slowdown
• Handles heavy tasks efficiently
• Enables retry mechanisms (future enhancement)

🔌 7. Integrations

1. Webhook

• Send HTTP requests to any API
• Supports:
  • GET / POST
  • Headers
  • JSON payload

2. Email

• Uses Joomla SMTP configuration
• Supports dynamic content

3. Telegram

• Requires:
  • Bot Token
  • Chat ID

📊 8. Logs & Monitoring

Logs include:

• Status (Success / Failed)
• Step details
• Error messages
• Timestamp

📈 Dashboard

• Total executions
• Error count
• Performance insights

🛠️ 9. Troubleshooting

❌ Queue not working

✔ Check:

• Cron job is running
• CLI path is correct

❌ Telegram not sending

✔ Verify:

• Bot Token
• Chat ID

❌ Email not sending

✔ Check:

• SMTP settings
• Joomla mail configuration

❌ Automation not triggered

✔ Verify:

• Plugin is enabled
• Correct trigger is selected

🔐 10. Security Notes

• Do not expose API keys
• Use HTTPS for webhooks
• Ensure proper admin permissions

🧪 11. Best Practices

• Avoid overly complex workflows initially
• Use delays to reduce load
• Monitor logs regularly
• Test automations before production use

💎 12. Pro Features (Preview)

• Advanced conditions
• Priority queue
• Advanced integrations
• Enhanced analytics

📌 13. FAQ

Can I use JAutomations without Cron?

❌ No — queue processing requires CLI execution

Can I add custom integrations?

✅ Yes — the system is extensible

Does it affect website performance?

❌ No — execution runs in the background

🚀 14. Support

• Documentation
• Community support
• (Pro) Priority support

💡 Future Documentation Enhancements

🔥 Advanced Docs

• Custom triggers
• API usage
• Developer guide

🎥 Tutorials

• Short video walkthroughs

📦 Examples Library

• Ready-made automation templates