PUQcloud Panel

The PUQcloud Panel is an open-source cloud management platform that enables IT service providers to efficiently manage cloud services and infrastructure for their customers. This book contains detailed documentation on the PUQcloud Panel, including installation instructions, configuration guides, and feature explanations. Thanks to the modular and scalable design of the PUQcloud Panel, businesses can easily integrate and customize the platform to fit their specific needs. The documentation covers various sections such as server setup, user management, networking, billing, and advanced security features.

• Description
• Admin Area Overview
• Login Page
• Dashboard and Menu Overview
• Clients: Manage Clients Overview
• Clients: Manage Users Overview
• Products: Manage Products Overview
• Products: Product Groups Overview
• Monitoring: Task Queue Overview
• Monitoring: Admin Sessions Overview
• Monitoring: Activity Log Overview
• Monitoring: Module Log Overview
• Monitoring: Notification History Overview
• Staff: Admins Management Overview
• Staff: Managing Administrator Groups Overview
• Automation: Scheduler Overview
• Automation: Horizon Overview
• Email & Notifications: Notification Senders Overview
• Email & Notifications: Notification Layouts Overview
• Email & Notifications: Notification Templates
• General: General Settings
• General: Countries
• General: Currencies

Description

PUQcloud Panel

Order Now | Download | FAQ

Preface

PUQcloud is ideal for businesses looking to offer a range of services, such as cloud hosting, SaaS, IT support, and hardware repair management, all while keeping costs low with its open-source model.

Technologies Used:

• Framework: Laravel
• Programming Languages: PHP, JavaScript
• Frontend: HTML, CSS, JavaScript
• Database: MySQL
• Queue Management: Redis
• API Integration: RESTful APIs
• Version Control: Git

Key Features:

• Fully Modular Design: The platform allows the easy addition of custom modules to extend functionality.
• Multitenancy Support: PUQcloud supports multiple businesses (or “companies”) under one installation, making it ideal for resellers or agencies.
• Automated Billing and Invoicing: Automate invoicing, payment processing, and service deployment.
• Cloud Services Deployment: Seamlessly deploy cloud services, manage customers, and scale services across different infrastructures.
• Helpdesk and Remote Support: Integrate support for remote hands, helpdesk systems, and ticketing, enhancing customer service and operational efficiency.
• Multi-Language Support: PUQcloud is available in multiple languages, helping businesses serve global clients.
• Advanced Taxation and Regulations: With flexible tax rules, PUQcloud allows businesses to automatically apply local tax rates based on the client's location.
• Elastic and Fast: Thanks to its queue-based architecture, PUQcloud is designed for speed and elasticity, ensuring high performance even with large-scale deployments.

Features for Service Providers:

• Cloud Management: Provision, manage, and automate the entire lifecycle of cloud services.
• Client Dashboard: Provide clients with an intuitive, self-service portal where they can view and manage their subscriptions, tickets, and usage.
• User and Access Management: Advanced user permissions and role management for service teams and clients.
• Analytics and Reporting: Real-time data and reporting to help businesses monitor performance, usage statistics, and financial metrics.
• Custom Modules: Build custom modules for unique service offerings or integrate with third-party services.
• Support for Hardware Repair Services: Manage repair services for electronic devices, offering clients an integrated service from IT support to hardware repairs.

Advantages of PUQcloud:

• Open Source: Free and open-source, making it accessible to anyone, with the ability to customize the codebase.
• Modular and Flexible: Add or remove modules as your business grows or your needs evolve.
• Free to Use: Unlike other cloud management systems, PUQcloud is free, lowering the cost for businesses starting out in the IT services market.
• Scalable: PUQcloud is built to scale, supporting businesses from small IT startups to large cloud service providers.
• Reliability: Built with best practices for high availability, PUQcloud is designed for mission-critical environments.
• Global Community: Collaborate with developers from all around the world, contributing to and benefiting from a vibrant open-source ecosystem.

Who is PUQcloud For?

• IT Service Providers: Automate and manage your client’s IT services from cloud hosting to software-as-a-service (SaaS).
• Cloud Resellers: Offer scalable cloud hosting solutions to clients with seamless billing and support.
• Managed Service Providers: Provide remote support, hardware repair services, and other managed IT services.
• Startups and Entrepreneurs: Start a cloud service business with a low-cost, reliable system.

Admin Area Overview

The Admin Area section of PUQcloud provides administrators with a comprehensive suite of tools to manage the platform effectively. This section is designed to give admins complete control over user management, system configuration, and monitoring features, ensuring that the cloud services run smoothly and efficiently. Administrators have access to various features and settings that allow them to manage clients, monitor server performance, and ensure that all modules are functioning as expected. The Admin Area is a critical part of the PUQcloud platform, offering both high-level oversight and detailed operational controls.

Login Page

The Login Page is the initial entry point for administrators to access the Admin Area of PUQcloud. It provides a secure interface where authorized users can input their credentials to gain access to the system.

On the Login Page, users are required to enter their email address and password. The page also offers the following features:

• Remember Me: A checkbox option that allows users to stay signed in on their device.
• Forgot Password: A link that redirects users to the password recovery page in case they forget their credentials.

Security is a primary concern on the Login Page. The page uses encryption to protect user credentials during transmission, ensuring that sensitive information is not exposed. Additionally, access to the Admin Area is restricted to authorized users only.

After successful login, administrators are directed to the Admin Dashboard, where they can begin managing the PUQcloud platform.

Dashboard and Menu Overview

PUQcloud Panel

Order Now | Download | FAQ

Dashboard Overview

The Dashboard is the main interface of the PUQcloud admin area, providing a quick overview of essential system information. It displays task queues, staff online status, automation status, and general PUQcloud information. The dashboard is designed to give administrators real-time insights into the system's performance and operational status.

• Task Queue: Shows the number of queued, pending, completed, failed, processing, and duplicate tasks.
  
  
• Staff Online: Displays a list of currently logged-in administrators.
  
  

  

• Automation Status: Indicates the status of automated tasks such as CRON jobs and queue processing through Horizon.
  
  

  

• PUQcloud Info: Displays system information including the current version, uptime, PHP version, server software, and time zone settings.

Dashboard Widgets Overview

The PUQcloud dashboard offers a flexible interface for administrators, allowing them to customize the layout by rearranging widgets. Widgets can be resized and repositioned according to user preferences, ensuring an optimal viewing experience for key system metrics and statuses.

Widget Settings Menu

Administrators can manage the visibility of dashboard widgets through the Widget Settings menu. The settings icon, represented by a gear symbol, is located at the bottom right corner of the dashboard. Clicking on this icon opens the Widget Settings menu, where administrators can enable or disable specific widgets.

Available Widgets:

• PUQCloud Info: Displays general information about the system, including version, uptime, PHP version, and server details.
• Automation Status: Shows the current status of CRON jobs and queue processes managed by Horizon.
• Task Queue: Provides an overview of queued, pending, completed, failed, and processing tasks.
• Staff Online: Displays the list of currently active admin users.

Managing Widgets

In the Widget Settings menu, each widget has a toggle switch to enable or disable its display on the dashboard. When a widget is disabled, it will no longer appear on the dashboard, providing a cleaner interface. The settings are saved automatically, ensuring the chosen configuration is retained for future sessions.

Widget Layout Customization

To customize the layout of widgets:

• Click and hold a widget to move it to a different position on the dashboard.
• Drag the widget to the desired location and release it to set its position.
• Resize widgets by dragging their corners to adjust their dimensions.

The flexibility of the dashboard layout ensures that administrators can prioritize the information most relevant to their operations, enhancing productivity and system monitoring efficiency.

Menu Overview

The Admin Area menu provides access to various sections and features for managing PUQcloud. The menu is organized into several categories:

Dashboard

The Dashboard link takes administrators to the main dashboard page, where they can see an overview of system performance and important metrics.

Clients

The Clients section allows administrators to manage client accounts and users.

• Manage Clients: Provides tools to add, edit, and manage client profiles.
• Manage Users: Allows administrators to manage user accounts associated with clients.

Products

The Products section is used to manage the services and products offered to clients. It includes the following submenus:

• Manage Products: Add, edit, and configure products and services.
• Product Groups: Organize products into groups for better management.
• Product Attributes: Define custom attributes for products.

Monitoring

The Monitoring section provides tools for tracking system activities and logs.

• Task Queue: View and manage queued tasks.
• Admin Sessions: Track active and past admin sessions.
• Activity Log: View a log of all system activities.
• Module Log: Track logs specific to system modules.
• Notification History: View the history of notifications sent through the system.

Staff

The Staff section is used to manage admin users and groups.

• Admins: Manage administrator accounts.
• Groups: Organize admins into groups with specific permissions.

Automation

The Automation section provides access to automated task management tools.

• Scheduler: Manage scheduled tasks.
• Horizon: Monitor and manage queue workers.

Email & Notifications

The Email & Notifications section is used to configure and manage notification settings.

• Notification Senders: Set up services for sending notifications.
• Notification Layouts: Create and manage notification templates.
• Notification Templates: Define reusable templates for notifications.

General

The General section contains general settings for the system.

• General: Configure system-wide settings.
• Countries: Manage country-specific settings.
• Currencies: Manage currency settings.

Add-ons

The Add-ons section provides access to additional modules and marketplace items.

• Marketplace: Browse and install add-ons from the marketplace.
• Modules: Manage installed modules.

Customization

The Customization section allows administrators to customize the admin interface.

• Admin Template: Configure the admin template settings.
• Info: View information about the current admin template.
• Layout Options: Customize the layout of the admin area.
• PUQ Sample Plugin: Access sample plugins for development purposes.
• Info: View information about the sample plugin.
• Simple Model Example: Access example code for creating models.
• Simple API Requests: View sample API requests.

 

Clients: Manage Clients Overview

PUQcloud Panel

Order Now | Download | FAQ

The Manage Clients section provides administrators with tools to view, search, and manage the client database within the PUQ Cloud Panel. This section is designed to simplify client management with an intuitive interface and detailed client information.

Key Features:

• Search Bar: Located at the top right corner, it allows quick searching of clients by email, name, or company.
• Client List: Displays a table with comprehensive information about each client, including:
• Owner: The email address and name of the client owner.
• Client: The client's full name and associated company (if applicable).
• Status: Indicates whether the client account is active or inactive. Active accounts are marked with a green label.
• Located: Displays the client's country and city along with a flag icon for easy identification.
• Created: Shows the timestamp when the client account was created.
• Edit Client Button: Located in the last column of the table, represented by a yellow edit icon. Clicking this button redirects to the client editing interface.

Pagination and Display Options:

• Entries Display: A dropdown menu to select how many clients are displayed per page (e.g., 10, 25, 50).
• Pagination: Allows navigation between multiple pages of clients.

Client Dashboard

Once a client is selected, the system opens a dedicated dashboard that provides detailed information and management options for the client. The dashboard is built with widgets, which administrators can customize.

Customization Features:

• Widget Management: Widgets can be toggled on or off by clicking the gear icon in the bottom-right corner of the page. This allows administrators to personalize their view.
• Drag and Drop: Widgets can be rearranged by dragging them to a desired position on the page.
• Resizable Widgets: Each widget can be resized to better fit the administrator's workflow.
• Personalized Layouts: Widget settings and layouts are saved individually for each administrator, enabling personalized dashboards.

Widgets:

• Client Information Widget: Displays detailed information about the client, including:
  • Name: The full name of the client.
  • Company Name: The name of the client’s company, if applicable.
  • Tax ID: The client’s tax identification number.
  • Email: The client’s email address.
  • Email Verified: Indicates whether the email is verified (e.g., "Not Verified").
  • Language: The preferred language of the client, with a flag representing their country.
  • Address: The full address of the client, including street, city, region, and country.
  • Created At: The exact date and time when the client account was created.
• Actions Widget: Provides quick management actions, including:
  • Login as Owner: Allows the administrator to log in as the client for troubleshooting or management purposes.
  • Block Large: Blocks the client with a specific reason or category labeled as "Large."
  • Block Normal: Blocks the client with a standard category labeled as "Normal."
  • Block Small: Blocks the client with a minor category labeled as "Small."

Tabs:

The client dashboard includes the following tabs for comprehensive management:

• Summary: Displays an overview of the client’s information and recent activity.
• Profile: Allows viewing and editing of the client’s personal details and preferences. Administrators can edit the client’s first name, last name, company name, tax ID, account status, preferred language, and currency. Additional notes for internal use can also be added in the "Admin Notes" field.
• Address Management: Administrators can manage multiple addresses associated with the client, including billing, shipping, and service addresses. Each address displays details like name, contact information, and full address. Administrators can add, edit, or delete addresses with the options available next to each entry.
• Users: Lists all users associated with the client account.
• Services: Shows all active, suspended, or pending services related to the client.
• Domains: Displays a list of domains owned by the client.
• Invoices: Provides access to all invoices, including paid, unpaid, and overdue statuses.
• Transactions: Details all financial transactions related to the client.
• Tickets: Lists support tickets submitted by the client, along with their statuses.
• Notifications: Displays all system notifications sent to the client.
• Session Log: Records recent logins and actions performed by the client for auditing and monitoring purposes.

Usage:

This section is essential for efficiently managing individual client accounts, monitoring their status, and performing quick actions. The flexible dashboard ensures a tailored experience for administrators, improving overall management efficiency.

Users Tab

The Users tab allows administrators to manage all users associated with the client account. Features include:

• User List: Displays a list of users linked to the account, including their roles and permissions.
• Add User: Provides an option to add new users to the account with specific roles (e.g., admin, editor).
• Edit User: Allows administrators to modify existing user details such as name, email, and access permissions.
• Remove User: Enables the deletion of users no longer associated with the account.
• Search and Filter: Includes a search bar and filtering options to easily locate specific users based on criteria like name, email, or role.

This tab streamlines user management by offering comprehensive tools to customize access levels and ensure account security.

Profile Tab

The Profile tab allows administrators to view and edit the client’s profile details. Key features include:

• Edit Personal Details: Administrators can update the client’s first and last name, company name, tax ID, and account status.
• Language and Currency Settings: Adjust the client’s preferred language and default currency.
• Admin Notes: Internal notes for tracking specific details about the client.
• Multiple Addresses: Administrators can manage multiple addresses categorized as billing, shipping, and service. Each address includes fields for name, street, city, state, country, and contact information. Options to add, edit, or delete addresses are available for enhanced flexibility.

This tab ensures comprehensive management of client details, providing the flexibility to handle diverse scenarios and requirements.

Clients: Manage Users Overview

PUQcloud Panel

Order Now | Download | FAQ

The Manage Users section in the PUQ Cloud Panel provides administrators with the tools to oversee and manage user accounts efficiently. This section allows for advanced management of user details, associations with clients, and access rights, ensuring a seamless user and client management experience.

Key Features:

• User List: Displays a table with detailed information about each user. The list includes:
  • Name: The full name of the user.
  • Status: Indicates whether the user is active or inactive. Active users are marked with a green label, while inactive users are marked accordingly.
  • Contacts: Lists the user’s primary email address and phone number for quick access.
  • Clients: Displays the number of clients linked to the user. Clicking on the icon provides a detailed view of all associated clients, allowing administrators to manage these relationships effectively.
  • Created: Shows the date and time when the user account was created in the system.
• Search and Filtering: A search bar at the top-right corner allows administrators to quickly locate users by name, email, or other attributes. Filters can be applied to narrow down the search based on specific criteria, such as status or client association.
• Actions: For each user, administrators can:
  • Edit User: Modify the user’s details, including name, email, phone number, and associated clients. This feature ensures that all information remains up-to-date.
  • Delete User: Permanently remove a user from the system. This action requires confirmation to prevent accidental deletions.
• User Creation: Administrators can add new users to the system using the Create button. During creation, key details such as name, email, phone number, and initial client associations can be defined.

Associations and Access Management:

The Manage Users section enables administrators to define and manage user-to-client relationships. This is crucial for scenarios where multiple users may need access to services or data associated with a single client.

• Client Associations: Users can be linked to one or multiple clients. Each association allows users to access specific services, invoices, tickets, or other resources tied to the client account.
• Roles and Permissions: Administrators can assign specific roles to users, such as:
  • Owner: Grants full access to the client’s account, including administrative privileges.
  • Editor: Allows users to modify certain details and access specific resources without full administrative rights.
  • Viewer: Provides read-only access to certain data, suitable for oversight without direct interaction.
• Service Access: Users linked to a client account can be granted access to specific services, such as hosting packages, domain management, or support tickets. This granular control ensures that users only have access to the resources they need.
• Notification Settings: Each user can receive specific notifications based on their role and association with the client. This includes invoice reminders, service updates, or ticket responses.

Detailed View:

Clicking on a user’s name provides a detailed view of their profile. This view includes:

• Personal Details: Full name, email address, phone number, and account status.
• Client Links: A list of all clients associated with the user. Each entry includes the client’s name, status, and the nature of the user’s role in the client account.
• Activity Logs: A record of actions performed by the user, such as login attempts, ticket submissions, or service modifications.

Edit User Modal:

When the Edit button for a user is clicked, a modal window appears, allowing administrators to modify the user’s details. The modal includes the following fields:

• Email: The user’s primary email address, which can be updated as needed.
• Firstname: The first name of the user.
• Lastname: The last name of the user.
• Phone Number: The user’s contact number, complete with a dropdown to select the country code.
• Language: The user’s preferred language, chosen from a dropdown list.
• Admin Notes: A text area for administrators to add internal notes about the user. These notes are visible only to administrators and can be used for reference or documentation purposes.

After making the necessary changes, administrators can save the updates by clicking the Save button, or they can discard changes by selecting Close.

Usage:

The Manage Users section is essential for maintaining an organized and secure user database. By providing detailed tools for user management, client associations, and role-based access control, this section ensures streamlined workflows and enhanced security for the PUQ Cloud Panel.

Products: Manage Products Overview

PUQcloud Panel

Order Now | Download | FAQ

The Manage Products section in the PUQ Cloud Panel provides administrators with tools to view, edit, and manage all products within the system. This section is crucial for keeping the product inventory organized and ensuring seamless product availability and visibility across the platform.

Key Features:

• Product List: Displays a table with detailed information about each product, including:
  • Key: A unique identifier for each product. This key is essential for internal operations and searching within the system.
  • Visibility: Indicates whether a product is visible to customers. Visible products are marked with a green check, while hidden ones are marked with a red cross.
  • Active Status: Displays whether the product is active. Inactive products cannot be purchased by customers.
  • Stock: Shows the current stock level for each product, providing insight into inventory availability.
• Actions: Administrators can perform the following actions for each product:
  • Edit: Modify product details, such as its name, key, visibility, status, and stock level.
  • Delete: Remove a product permanently from the system. This action requires confirmation to avoid accidental deletions.
• Search and Pagination:
  • Search: A search bar at the top-right corner allows administrators to quickly locate products by key, name, or other attributes.
  • Pagination: Enables navigation through the product list, with options to display a specified number of entries per page.

Product Details and Attributes:

Each product in the system can have associated attributes and groupings, allowing for advanced customization and categorization. Administrators can manage these attributes through the following options:

• Product Attributes: Define specific characteristics for products, such as size, color, or technical specifications. These attributes provide additional details for customers and help in categorization.
• Product Groups: Organize products into groups for easier management and customer browsing. For instance, hosting plans, domains, or software licenses can be grouped together.

Usage:

The Manage Products section is vital for maintaining an organized product database and ensuring that all products are up-to-date, available, and visible to customers as needed. This section streamlines the administrative workflow for product management, enhancing overall system efficiency.

Editing a Product

The Editing a Product section in the PUQ Cloud Panel allows administrators to modify key attributes of a product and customize its settings across multiple dimensions. This section provides flexibility to ensure each product aligns with business requirements and customer expectations.

Tabs Overview:

• General: Main settings and multi-language content editing.
• Pricing: (Description to be added).
• SEO URLs: (Description to be added).

General Tab

The General tab provides options to manage fundamental product settings. It includes the following features:

• Key: A unique identifier for the product, used internally for searching and referencing the product within the system.
• Visibility: Toggle the Hidden switch to determine whether the product is visible to customers.
• Retired: Use the Retired switch to mark the product as retired, removing it from active listings without deletion.
• Stock Control: Enable or disable stock control for the product. If enabled, specify the quantity available in stock.

Multi-Language Support

Administrators can provide content for multiple languages supported by the system. This ensures localization and customization for diverse audiences. The following fields are available for each language:

• Name: A localized name for the product.
• Short Description: A brief description of the product.
• Description: A detailed description of the product.
• Notes: Additional internal notes about the product. These are not visible to customers and are for administrative purposes only.

Language-specific content can be entered by clicking the flag icons representing available languages. This allows administrators to create tailored content for each locale.

Pricing Tab

The Pricing tab in the PUQ Cloud Panel is dedicated to managing the pricing structure for products. This section allows administrators to define various payment periods, currencies, and associated costs, ensuring flexible and comprehensive pricing models for different customer needs.

Key Features:

• Periods: The pricing structure supports multiple billing periods, including:
  • One-Time Payment: A single payment for the product without recurring charges.
  • Daily: Recurring payments every day.
  • Weekly: Recurring payments every week.
  • Bi-Weekly: Recurring payments every two weeks.
  • Monthly: Recurring payments every month.
  • Quarterly: Recurring payments every three months.
  • Semi-Annually: Recurring payments every six months.
  • Annually: Recurring payments every year.
  • Every Three Years: Payments recurring every three years.
• Currency: Administrators can set the pricing in multiple currencies, ensuring global compatibility and customer convenience.
• Cost Breakdown: Each period includes detailed cost fields:
  • Setup Fee: A one-time cost for initializing the product.
  • Base Price: The recurring cost for the selected period.
  • Idle Fee: Cost incurred when the product is idle but active in the system.
  • Switch Down Fee: Cost for downgrading the product or its features.
  • Switch Up Fee: Cost for upgrading the product or its features.
  • Uninstall Fee: Cost for removing the product from the system.
• Actions:
  • Edit: Modify an existing pricing entry.
  • Delete: Permanently remove a pricing entry. This action requires confirmation to prevent accidental deletion.

Adding a New Pricing Period:

Administrators can add new pricing entries by clicking the Add button. During creation, the following fields must be defined:

• Period: Select the desired billing period from the available options.
• Currency: Choose the appropriate currency for the pricing.
• Setup Fee: Define the initial cost of setting up the product.
• Base Price: Specify the recurring price for the product.
• Idle Fee: Add a cost for idle usage, if applicable.
• Switch Down Fee: Include costs for downgrading product features.
• Switch Up Fee: Include costs for upgrading product features.
• Uninstall Fee: Define the cost of removing the product.

Usage:

The Pricing tab ensures that administrators can manage a variety of pricing models to cater to different customer requirements. By offering flexible billing periods, multiple currencies, and detailed cost breakdowns, this section supports dynamic and scalable pricing strategies.

SEO URLs Tab

The SEO URLs tab in the PUQ Cloud Panel enables administrators to configure search-engine-optimized URLs for products. This feature ensures that each product is discoverable online and ranks higher in search engine results, improving visibility and accessibility for potential customers.

Key Features:

• Customizable URLs: Administrators can define unique and descriptive URLs for each product, ensuring better identification by search engines.
• Language-Specific URLs: For multi-language systems, administrators can create distinct URLs for each supported language, enhancing localization and accessibility.
• Preview Functionality: Allows administrators to preview how the URL will appear to users and search engines.
• URL Validation: The system checks for duplicate or invalid URLs to prevent conflicts and ensure proper functionality.

Adding or Editing URLs:

When adding or editing a product's SEO URL, the following fields can be configured:

• Language: Select the language for which the URL is being configured.
• URL Path: Define the specific path for the product's URL, ensuring it is descriptive and relevant.
• Meta Title: Set a meta title that will appear in search engine results, summarizing the product.
• Meta Description: Provide a brief description that appears below the meta title in search results, offering a concise summary of the product.
• Keywords: Add relevant keywords to improve search engine indexing and ranking.

Usage:

The SEO URLs tab is essential for improving the discoverability of products in search engines. By optimizing URLs and meta information, businesses can enhance their online presence and attract more customers.

Products: Product Groups Overview

PUQcloud Panel

Order Now | Download | FAQ

The Product Groups section in the PUQ Cloud Panel is designed to organize and manage groups of products efficiently. This feature enables administrators to categorize products into groups, making it easier to manage and navigate through large inventories.

Key Features:

• Group List: Displays all product groups in a table format, including:
  • Key: A unique identifier for each product group, used for internal referencing and search functionality.
  • Visibility: Indicates whether a product group is visible or hidden. Visible groups are marked with a green check, while hidden groups are marked accordingly.
  • Products: Shows the number of products within each group, allowing administrators to assess group content at a glance.
  • Order: Allows administrators to adjust the position of product groups in the list using up and down arrows for reordering.
• Actions:
  • Edit Group: Modify the details of an existing product group, including its name, key, and visibility settings.
  • Delete Group: Permanently remove a product group from the system. This action requires confirmation to prevent accidental deletions.
• Search and Filter: A search bar at the top-right corner allows administrators to locate specific groups quickly. Filters can also be applied to refine the search results.

Technical Details:

• Key Usage: The key for each group is a unique string that acts as an identifier for API calls, database queries, and other internal processes. This ensures that groups are easily distinguishable and traceable within the system.
• Visibility Settings: Visibility controls determine whether a product group is accessible to end-users or remains hidden for internal purposes. This feature allows for better inventory management and phased rollouts of new product lines.
• Order Management: The ordering functionality ensures that groups can be arranged in a hierarchy that aligns with business priorities or user navigation preferences. The system automatically updates the order index after each adjustment.

Creating a New Product Group:

Administrators can add new product groups by clicking the Create button. During creation, the following fields must be defined:

• Key: Enter a unique identifier for the group.
• Name: Provide a descriptive name for the group.
• Visibility: Set the group as visible or hidden based on its intended use.

Usage:

The Product Groups section is essential for organizing and streamlining product management. By categorizing products into logical groups, administrators can improve navigation, enhance customer experience, and ensure efficient inventory management.

Product Group Editing

The Product Group Editing section in the PUQ Cloud Panel allows administrators to manage and customize product groups with ease. This section is divided into three key tabs:

General

The General tab provides administrators with tools to modify the overall settings of a product group. Here are its features:

• Key: A unique identifier for the product group, used for internal reference and search functionality.

• Hidden: Administrators can toggle this setting to hide or display the group in the product catalog.

• Language-Specific Settings: The system supports multiple languages, and administrators can define the following for each language:

  • Name: The name of the group as it will appear to users.

  • Short Description: A brief summary of the group’s purpose or contents.

  • Description: A detailed explanation of the group, tailored for the selected language.

  • Notes: Additional internal information or instructions for the product group.

This tab ensures comprehensive customization for multilingual environments and provides flexibility in group visibility.

Products

The Products tab displays all products associated with the group and allows administrators to manage them efficiently. Features include:

• List of Products:

  • Key: A unique identifier for each product.

  • Visibility: Indicates whether the product is visible in the catalog.

  • Stock Status: Shows if the product is currently available in the store.

• Positioning: Products can be reordered within the group by dragging them to the desired position, ensuring optimal display order.

• Editing and Removal:

  • The Edit button allows administrators to modify product details directly.

  • The Remove button detaches the product from the group without deleting it from the system.

This tab is crucial for organizing product groups and maintaining a well-structured catalog.

SEO URLs

The SEO URLs tab enables administrators to configure search engine optimization settings for the product group. Key features include:

• Customizable URLs: Define unique URLs for the group to enhance search engine discoverability.

• Language-Specific URLs: Set distinct URLs for each supported language, catering to localized audiences.

• Meta Information:

  • Meta Title: A concise, descriptive title for search engine results.

  • Meta Description: A summary that appears in search engine snippets.

  • Keywords: Relevant terms to improve indexing and ranking.

• Validation: The system ensures URLs are unique and properly formatted to prevent conflicts.

This tab enhances the group’s visibility in search results, driving more traffic to the store.

Monitoring: Task Queue Overview

PUQcloud Panel

Order Now | Download | FAQ

The Task Queue section in the PUQ Cloud Panel is designed to monitor and manage all tasks executed within the system. Each action triggered in the panel, such as background processes, administrative tasks, or scheduled operations, is queued and processed here. This ensures seamless and controlled execution of system jobs while providing administrators with detailed monitoring capabilities.

Key Features:

• Task Overview: Displays a list of all queued tasks, including their current status:
  • Pending: Tasks waiting to be executed.
  • Processing: Tasks currently being executed.
  • Failed: Tasks that encountered an error during execution.
  • Completed: Successfully executed tasks.
• Filtering: Administrators can filter tasks based on date ranges, making it easier to find specific jobs within a defined timeframe.
• Job Details: Each task entry includes detailed information:
  • Job Name: A clear identifier for the task, such as "App\Jobs\CheckingAdminPermissionsJob."
  • ID: A unique identifier for each task, enabling precise tracking.
  • Queue: Indicates the queue assigned to the job, along with the number of attempts and retries (e.g., 0/3).
  • Timestamp: Shows the exact date and time when the task was queued.
• Action Buttons: Includes options to view detailed information about each job, such as its logs, execution history, or potential errors.
• Real-Time Updates: Administrators can enable live updates to monitor task progress dynamically, with adjustable refresh intervals.

Usage:

This section is essential for maintaining transparency and control over system operations. Administrators can:

• Monitor ongoing tasks and their progress.
• Identify and resolve issues with failed jobs by reviewing error details.
• Ensure that critical background tasks are executed in a timely manner.

Technical Details:

• System Queue Management: The PUQ Cloud Panel leverages a robust queue system to prioritize and execute tasks efficiently. Each queue can handle multiple tasks concurrently, ensuring high system performance.
• Job Retry Mechanism: Failed tasks are retried automatically based on predefined retry policies. The retry count is displayed in the "Queue" column (e.g., 0/3).
• Error Logging: All task errors are logged for review. Administrators can access detailed error messages to diagnose and fix issues.

Screenshot Reference:

The interface provides a clean layout with filters, job statuses, and detailed task information, as shown in the attached screenshot:

• Filter: A date range selector allows narrowing down tasks to a specific period.
• Status Labels: Color-coded labels (e.g., yellow for "Pending" and red for "Failed") make it easy to identify the task's status.
• Action Icons: The eye icon enables administrators to view detailed logs and job execution specifics.

Monitoring: Admin Sessions Overview

PUQcloud Panel

Order Now | Download | FAQ

The Admin Sessions section within the Monitoring menu of the PUQ Cloud Panel provides detailed logging and tracking of administrative activity. This section ensures transparency and accountability by maintaining a comprehensive log of all administrator sessions.

Key Features:

• Session Logs: The section lists all administrative sessions, including details such as:
  • Date: The exact date and time when the session occurred.
  • Admin: The name or identifier of the administrator who initiated the session.
  • IP Address: The IP address from which the administrator accessed the system.
  • URL: The specific URL accessed by the administrator during the session, categorized as either API or WEB.
• Filtering Options:
  • Date Range: Allows filtering sessions based on a specified date and time range.
  • Hide Me: A toggle option to exclude the current administrator’s sessions from the view for better focus on other administrators.
• Real-Time Updates: The section can be set to auto-refresh at intervals such as 5 seconds, ensuring administrators see the latest activity logs in real-time.
• Pagination: Supports navigation through a large number of logs, with options to select the number of entries displayed per page.

Details Logged:

The following details are captured for each session:

• Type: Categorized as API calls or WEB-based interactions.
• HTTP Method: Specifies whether the action was a GET, POST, or another HTTP method.
• Session Activity: Tracks specific actions taken by the administrator within the system, such as accessing logs, modifying settings, or interacting with modules.

Usage:

The Admin Sessions section is essential for tracking administrative activities, troubleshooting issues, and maintaining the integrity of the system. By providing a detailed overview of all sessions, administrators can monitor unauthorized access attempts, audit system usage, and ensure compliance with internal policies.

Monitoring: Activity Log Overview

PUQcloud Panel

Order Now | Download | FAQ

The Activity Log section in the PUQ Cloud Panel under Monitoring provides a comprehensive view of all activities performed within the system. It serves as a vital auditing tool, enabling administrators to track actions, identify changes, and ensure transparency in system usage.

Overview

This log records details about every action initiated in the system, including updates, logins, and other significant events. The information is presented in a tabular format for easy navigation and understanding.

Key Features:

• Date and Time: Displays the exact timestamp when the action occurred, ensuring chronological tracking.
• IP Address: Shows the IP address of the user or system that initiated the action, aiding in tracing the source of activity.
• Initiator: Identifies the user, system, or process responsible for the action. For administrators, this field includes the username and associated email.
• Action Type: Categorizes the type of action, such as:
  • Update: Represents modifications made to system data.
  • Create: Records the creation of new entities or resources.
  • Delete: Captures deletions of resources or data.
  • Login: Logs access attempts to the system by users or administrators.
• Description: Provides detailed information about the action, including references to models, entities, or resources affected by the activity.
• Filter Options: Administrators can narrow down results using date ranges and specific keywords to locate relevant logs efficiently.
• Search Functionality: A search bar allows quick filtering based on specific terms or identifiers.
• View Details: Each entry includes a View button, which provides in-depth information about the selected action for more granular analysis.

Technical Details:

• Data Storage: All activity logs are stored in a secure database with redundancy to prevent data loss.
• Log Retention: Logs are retained based on system policies, which can be configured by the administrator to comply with regulatory or operational requirements.
• Integration: This section integrates with other monitoring tools, such as Admin Sessions and Module Log, for holistic system insights.

Usage Scenarios:

• Auditing: Track changes made by administrators to ensure compliance with internal policies.
• Security: Identify unauthorized access or suspicious activities by monitoring login attempts and other critical actions.
• Troubleshooting: Review logs to pinpoint errors or unintended changes that may impact system functionality.

Best Practices:

• Regularly review activity logs to ensure system integrity and identify potential issues early.
• Use filters and search functionality to focus on critical periods or specific actions.
• Export logs periodically for offline storage or integration with external auditing systems.

The Activity Log is a crucial tool for maintaining accountability and transparency within the PUQ Cloud Panel. By providing a detailed and searchable record of system activities, it empowers administrators to ensure smooth and secure operations.

Monitoring: Module Log Overview

PUQcloud Panel

Order Now | Download | FAQ

The Module Log section in the PUQ Cloud Panel provides administrators with a detailed log of all activities related to the modules integrated within the system. This section is crucial for diagnosing issues, auditing changes, and monitoring the performance of various modules.

Key Features:

• Log Entries: Displays all recorded module activities, including actions, timestamps, and statuses. Each entry helps trace the execution of module-specific tasks.
• Filters: Administrators can apply date and time filters to focus on specific periods, making it easier to pinpoint relevant logs.
• Details: Each log entry includes the following fields:
  • Date: The exact time when the action occurred.
  • Name: Identifies the module associated with the log entry.
  • Action: Describes the operation performed, such as installation, update, or removal.
  • Level: Indicates the severity or status of the action, such as INFO, WARNING, or ERROR.
• Real-Time Updates: The module log can be configured to auto-refresh at specified intervals, ensuring administrators see updates as they occur.
• Search Functionality: Allows administrators to quickly find specific entries using keywords or module names.

Usage:

The Module Log is designed to streamline the monitoring and troubleshooting process for administrators. By providing a comprehensive view of module-related actions, it helps ensure system stability and efficient module management.

Example Use Cases:

• Issue Diagnosis: Identify errors or warnings generated by modules to quickly resolve technical problems.
• Performance Monitoring: Track the execution of scheduled tasks or updates performed by modules.
• Change Auditing: Review logs to confirm recent module installations or configuration changes.

Monitoring: Notification History Overview

PUQcloud Panel

Order Now | Download | FAQ

The Notification History section in the PUQ Cloud Panel provides a comprehensive log of all notifications sent through the system. This section is essential for tracking communication activities, ensuring transparency, and diagnosing any notification-related issues.

Key Features:

• Filtering Options: Administrators can filter the notification logs by specific time ranges, types of notifications, or delivery statuses to pinpoint specific entries quickly.
• Detailed Notification Entries: Each log entry includes the following information:
  • Date: The exact timestamp when the notification was sent.
  • Recipient: The user or system component that received the notification.
  • Type: Specifies the type of notification, such as email, system message, or SMS.
  • Status: Indicates whether the notification was successfully delivered, failed, or pending.
  • Message Preview: A short snippet of the notification content for quick reference.
  • Additional Details: Metadata associated with the notification, including priority level and system tags.
• Search Functionality: A search bar allows administrators to locate specific notifications by keywords, recipient names, or message content.
• Pagination: The system divides the notification history into pages, enabling efficient navigation through extensive logs.
• Real-Time Updates: Notifications can be monitored live with automatic refresh settings to ensure administrators have the latest information.

Viewing Notification Details:

Clicking on a specific notification entry expands a detailed view, revealing the full message content, associated metadata, and any error messages or logs related to delivery failures. This helps administrators identify and resolve issues efficiently.

Usage:

The Notification History section is critical for maintaining system reliability and ensuring successful communication with users. By providing a clear and detailed log of all notifications, it helps administrators:

• Verify the delivery of important messages.
• Investigate and troubleshoot failed notifications.
• Maintain a historical record of communication activities for auditing purposes.

Staff: Admins Management Overview

PUQcloud Panel

Order Now | Download | FAQ

The Admins section, located within Settings > Staff, provides tools for managing system administrators. This feature is essential for controlling access to the administrative panel and ensuring proper roles and permissions for each user.

Key Features:

• Administrator List: Displays all current administrators, showing key information such as:
  • Email: The email address associated with the administrator account.
  • First Name: The administrator’s first name for identification purposes.
  • Last Name: The administrator’s last name for identification purposes.
  • Status: Indicates whether the administrator account is active (green checkmark) or inactive.
• Actions:
  • Edit: Allows modifying administrator details, such as name, email, or permissions.
  • Delete: Permanently removes the administrator from the system. A confirmation prompt ensures accidental deletions are avoided.
• Search: The search bar enables quick filtering of administrators by name or email.
• Pagination: Controls the number of entries displayed per page, making it easier to navigate large lists.

Adding a New Administrator:

Clicking the Create button opens a form where administrators can input the following details:

• Email: The email address for the new administrator account.
• First Name: The administrator’s first name.
• Last Name: The administrator’s last name.
• Password: A secure password for account access.
• Confirm Password: Ensures the password is entered correctly.
• Status: Specifies whether the account should be active upon creation.

Editing Administrator Details

The "Edit Administrator" functionality within the PUQ Cloud Panel allows for managing detailed information about administrators and assigning them specific roles or permissions to ensure flexibility, security, and optimal organization of administrative tasks within the system.

Editable Fields

Administrators can modify the following fields in the "Edit Administrator" section:

• Email: The email address associated with the administrator's account. This field ensures that the administrator can receive important notifications and correspondence.
• Firstname: The administrator’s first name, which helps identify the user within the system and maintain proper records.
• Lastname: The administrator’s last name, used alongside the first name to provide complete identification.
• Language: The preferred language for the administrator’s interface, selectable from a dropdown menu. This ensures a user-friendly experience tailored to individual preferences.
• Phone Number: The administrator’s phone number, including country code. This field is particularly useful for contact purposes or integrating with two-factor authentication systems.
• Status: Enable or disable an administrator account ("Enabled" or "Disabled"). This feature is critical for managing active personnel and suspending access for inactive or terminated staff.
• Groups: Assign the administrator to one or multiple groups with predefined permissions. Groups dictate the administrator’s level of access and operational capabilities within the system.
• Notes: Add internal notes related to the administrator’s account or role. This can include special instructions, reminders, or historical context about the account.

Groups and Permissions

Groups are a vital feature in the PUQ Cloud Panel that allow granular control over administrator access. By assigning administrators to specific groups, you can define the scope of their permissions. Groups are highly flexible and customizable to suit various organizational needs. Below are some examples of group configurations:

• View-Only Accountant:
  • Permissions: Can only view invoices and financial data. They cannot modify, delete, or add data, ensuring secure access to sensitive information.
  • Use Case: Ideal for accounting staff who need access to billing information but should not edit or access other areas. This ensures separation of duties and enhances internal controls.
• Product Manager:
  • Permissions: Can edit product details, manage pricing, and update inventory. They can also access relevant reports to monitor product performance.
  • Use Case: Suitable for administrators responsible for managing products and their associated data. This group empowers them to maintain an up-to-date catalog and respond to market changes.
• Super Admin:
  • Permissions: Full access to all sections and functionalities of the system, including user management, system logs, and settings adjustments.
  • Use Case: Reserved for high-level administrators who oversee all operations. They ensure that the system runs smoothly and can intervene in critical situations.

Advanced Flexibility

Groups can be customized to allow or restrict access to specific features based on the organization’s structure. For instance:

• An administrator can be allowed to view logs but not modify system settings, maintaining accountability without compromising security.
• Permissions can be assigned for specific modules, such as allowing access only to the Task Queue or Notification History. This ensures that administrators focus on their designated responsibilities.
• Temporary permissions can be granted to an administrator for specific tasks and revoked afterward. This feature is particularly useful during audits, special projects, or temporary staffing situations.

Changing Passwords

The "Edit Administrator" section includes an option to Change Password. This is useful for resetting an administrator’s password if it is forgotten or needs to be updated for security reasons. Password changes can be enforced periodically to comply with organizational security policies.

Session IPs

Administrators can view the Session IPs associated with their account to track login activity and ensure security. This feature provides a detailed record of IP addresses used to access the account, helping identify unauthorized access attempts. Any suspicious activity can be flagged and addressed promptly, ensuring the integrity of the system.

Usage

This feature ensures that administrator accounts can be managed efficiently and securely. By leveraging the group and permission functionality, organizations can enforce strict access control while maintaining operational flexibility. The ability to customize groups and track activity adds a layer of accountability and transparency, fostering a secure and well-regulated administrative environment.

Staff: Managing Administrator Groups Overview

PUQcloud Panel

Order Now | Download | FAQ

The "Groups" section in the PUQ Cloud Panel under Settings > Staff is an advanced and critical feature for configuring and managing administrator groups. This section allows for creating highly customizable roles, enabling organizations to assign specific permissions to administrators based on their responsibilities. By using this feature, the PUQ Cloud Panel ensures granular control over access and operations within the system, making it an essential tool for maintaining security and efficiency.

Overview of Groups

Administrator groups are designed to provide a structured and scalable way to manage permissions and organize administrative tasks. Each group consists of the following attributes:

• Name: A unique identifier for the group, ensuring it can be easily distinguished from others within the system. This name serves as the primary reference for its purpose.
• Description: A concise explanation of the group’s purpose, providing necessary context for its creation and functionality. This is particularly useful for larger organizations managing multiple groups.
• Type: Defines the group’s functional category, such as "Modules," "System," "Admin Notifications," or others. This categorization aids in organizing roles based on specific operational domains.

Core Functionalities

The Groups section offers a wide range of functionalities, empowering administrators to manage roles and permissions effectively:

• Create Groups: Administrators can create new groups by defining their name, description, and type. This feature enables organizations to set up custom roles tailored to unique business needs.
• Edit Groups: Update existing groups to reflect changes in organizational structure or responsibilities. For example, permissions can be expanded or restricted as necessary.
• Delete Groups: Safely remove groups that are no longer needed. This ensures the system remains uncluttered and easy to navigate, enhancing usability.

Flexibility and Customization

The PUQ Cloud Panel’s group management system is highly flexible, enabling administrators to configure roles for a variety of scenarios. Here are some examples of how groups can be utilized:

• Module-Specific Access:
  • Groups can be created to grant access exclusively to certain modules, such as Monitoring, Products, or Invoices. For instance, a "Monitoring Group" might have permissions to view logs and manage task queues without accessing product configurations.
  • Use Case: This approach is ideal for dividing responsibilities, ensuring that administrators focus solely on their assigned tasks.
• System-Wide Roles:
  • Groups like "Super Admin" offer unrestricted access to all features and functionalities, including user management, system logs, and configurations.
  • Use Case: Designed for top-level administrators, this role is critical for oversight, troubleshooting, and high-level decision-making.
• Notification Management:
  • Groups dedicated to managing admin notifications allow specific users to monitor and respond to system alerts efficiently.
  • Use Case: Ensures critical updates and alerts are handled by designated administrators, improving response times and reducing risk.

Nested Groups

A standout feature of the PUQ Cloud Panel is its support for nested groups. This functionality allows one group to inherit permissions from another, creating a hierarchical structure that simplifies role management. By using nested groups, administrators can avoid redundant configurations and maintain consistency across roles.

• Example: A "Finance Team" group may include "Accountant" and "Billing Manager" sub-groups. This setup ensures that all members of the Finance Team inherit the permissions of these specialized roles, streamlining administrative assignments.

Security and Accountability

Groups play a pivotal role in enhancing security by restricting access based on predefined roles. This minimizes the likelihood of unauthorized actions or data breaches. Additionally, all activities performed by group members are logged and can be reviewed in the Activity Log, ensuring accountability and transparency. These logs provide a detailed record of actions, enabling administrators to identify and address potential issues proactively.

Editing Groups

The PUQ Cloud Panel provides robust capabilities for editing existing administrator groups, ensuring that roles can be refined and adjusted as organizational needs evolve. The editing interface includes the following options:

• Name and Description: Administrators can update the group’s name and description to better align with its purpose or changes in responsibilities. This ensures clarity and relevance over time.
• Modules: Assign or modify the modules associated with the group. For instance, a group may be granted permissions to manage specific plugins, access SMTP configurations, or control PHPMAIL notifications.
• Notification Permissions: Administrators can enable or disable notification-related permissions for the group, allowing for tailored access to critical system alerts.
• Plugin Controls: Groups can be configured with permissions for specific plugins, such as managing models, API requests, or executing test connections.

These editing features highlight the panel’s flexibility, allowing administrators to create precise, role-specific configurations. For example, a "Testers" group might only have permissions for executing test connections and viewing plugin data, while a "Developers" group could have broader access, including the ability to modify plugins and analyze system logs.

Usage and Best Practices

To fully leverage the group management feature, administrators should adhere to the following best practices:

• Define Clear Roles: Conduct a thorough analysis of organizational roles and responsibilities before creating groups. This ensures that permissions align with operational needs.
• Use Descriptive Names: Choose clear and specific names for groups, such as "Support Team," "Product Managers," or "Finance Team," to avoid confusion and streamline navigation.
• Regularly Review Permissions: Periodically audit group settings to ensure they remain relevant and appropriate. Remove or update permissions as organizational needs evolve.
• Limit Super Admin Access: Restrict the "Super Admin" role to a select group of trusted individuals. This reduces the risk of accidental or intentional misuse of system-wide permissions.

Advanced Role Configurations

The flexibility of the group management system allows for advanced configurations, such as:

• Creating roles that can view specific logs without modifying system settings, ensuring transparency without compromising security.
• Setting permissions for individual modules, such as granting access solely to the "Notification History" or "Task Queue."
• Implementing temporary roles with time-limited permissions for special projects, audits, or temporary staffing needs.

Conclusion

The Groups section in the PUQ Cloud Panel offers a robust and versatile solution for managing administrative roles and permissions. By leveraging its extensive customization options, organizations can create a secure, efficient, and well-organized administrative environment. The ability to configure nested groups, define granular permissions, and track activities ensures that every administrator operates within their designated scope, contributing to a streamlined and secure workflow.

Automation: Scheduler Overview

PUQcloud Panel

Order Now | Download | FAQ

The "Scheduler" section in the PUQ Cloud Panel under Automation is a robust tool designed for managing automated tasks across the system. This feature ensures that routine operations are executed efficiently, consistently, and without manual intervention, enhancing overall system reliability and productivity.

Overview of Scheduler

Schedulers are configured instructions that automate specific system actions at defined intervals. These actions range from cleaning up logs and sessions to managing tasks and maintaining system performance. The Scheduler interface provides administrators with an intuitive and powerful way to oversee and adjust these automated operations.

Key Components

The Scheduler section is divided into multiple panels, each representing a category of tasks or system actions. The interface includes the following key elements:

• Task Name: Displays the name of the scheduled task, providing a clear understanding of its purpose (e.g., System:clearingLostTasks, System:Cleanup).
• Last Run: Indicates the most recent execution time of the task, allowing administrators to monitor activity and verify successful operation.
• Next Run: Shows the scheduled time for the task’s next execution, ensuring transparency in scheduling.
• Interval: Configurable time expressions (e.g., CRON syntax) that define the task’s execution frequency, such as every 30 minutes.
• Toggle Switch: Enables or disables specific tasks, giving administrators control over active automation processes.
• Reset Button: Allows administrators to reset task configurations to default settings if needed.

Functionality

The Scheduler enables administrators to configure and monitor automated tasks. Key functionalities include:

• Task Management: Administrators can view and modify task configurations, ensuring they align with operational requirements. Tasks such as clearing logs, processing pending tasks, or removing duplicates are standard examples.
• Custom Intervals: Using CRON expressions, administrators can define task frequencies with high precision, tailoring automation to the system’s specific needs.
• Error Handling: The interface highlights tasks that fail to execute, enabling prompt troubleshooting and minimizing disruptions to automation workflows.
• Comprehensive Status Indicators: Visual cues, such as icons and color coding, provide immediate insight into the task’s current state (e.g., pending, running, failed).

Use Cases

The Scheduler is versatile and supports various applications, including but not limited to:

• System Maintenance: Automating routine tasks like cleaning old logs and sessions ensures that the system remains efficient and clutter-free.
• Task Management: Handling recurring actions such as processing queued jobs or removing obsolete data to optimize system performance.
• Data Integrity: Regularly scheduled checks for duplicate entries or failed tasks help maintain data consistency and reliability.

Best Practices

To maximize the Scheduler’s efficiency, consider the following best practices:

• Define Clear Intervals: Use CRON expressions to set intervals that balance system performance with operational requirements.
• Monitor Task Execution: Regularly review the Last Run and Next Run fields to ensure tasks are executing as expected.
• Enable Relevant Tasks Only: Disable tasks that are not immediately needed to reduce system overhead and potential conflicts.
• Respond to Failures: Promptly address failed tasks by reviewing logs and troubleshooting issues to maintain system reliability.

Technical Details

Schedulers in the PUQ Cloud Panel utilize CRON syntax for time-based job execution. This provides flexibility in defining schedules, such as:

• */30 * * * * - Every 30 minutes
• 0 2 * * * - Daily at 2 AM
• 0 0 1 * * - Monthly on the first day

Each task is executed by the system’s job queue, ensuring tasks run sequentially and do not conflict with each other. Administrators can view detailed execution logs for each task in the Activity Log, aiding in diagnosing and optimizing automation processes.

Conclusion

The Scheduler is an indispensable tool in the PUQ Cloud Panel’s Automation suite, providing robust capabilities for managing system tasks with precision and efficiency. By leveraging its flexible configurations and monitoring features, organizations can automate repetitive tasks, enhance system performance, and focus on strategic initiatives. Its intuitive interface and powerful functionality make it a cornerstone of efficient system management.

Automation: Horizon Overview

PUQcloud Panel

Order Now | Download | FAQ

 

The Horizon module, integrated into the PUQ Cloud Panel under the Automation menu, serves as a sophisticated queue management and monitoring tool, leveraging the capabilities of Laravel Horizon. This module provides administrators with a robust interface to oversee and control background task execution, ensuring the system's optimal performance and reliability.

What is Laravel Horizon?

Laravel Horizon is a powerful open-source tool designed for monitoring and managing queues in applications built on the Laravel framework. It simplifies the process of overseeing jobs, provides detailed metrics, and allows for real-time monitoring of queue statuses. Horizon's intuitive dashboard offers administrators the ability to track job progress, identify bottlenecks, and optimize task processing in a seamless and efficient manner.

Key Features of Horizon in PUQ Cloud Panel

1. Real-Time Monitoring

The Horizon dashboard provides an overview of all queued tasks, their statuses, and associated metrics, such as:

• Jobs Per Minute: Displays the number of jobs processed in real-time.
• Total Processes: Indicates the total number of active processes handling queued tasks.
• Failed Jobs: Lists tasks that encountered errors during execution, enabling quick troubleshooting.
• Max Wait Time: Highlights the longest wait time for tasks in the queue.
• Status: Shows the overall activity status of the queue system (e.g., Active).

2. Queue Management

Within the PUQ Cloud Panel, Horizon facilitates efficient management of multiple queues, such as:

• AdminNotification: Handles notifications and alerts for administrators.
• Cleanup: Manages system maintenance tasks, such as clearing logs and sessions.
• System: Processes critical system tasks to ensure stability and performance.

Administrators can view the current workload for each queue, including the number of jobs, processes, and wait times, allowing for precise adjustments to queue configurations.

3. Supervisor Management

Horizon’s supervisor feature in the PUQ Cloud Panel enables administrators to assign and balance processes across queues. Supervisors can be configured to:

• Run specific queues, such as Cleanup or AdminNotification.
• Allocate a predefined number of processes to handle tasks efficiently.
• Automate load balancing for consistent performance across all queues.

4. Metrics and Statistics

Detailed metrics provided by Horizon help administrators analyze queue performance over time. These metrics include:

• Jobs Past Hour: Indicates the number of jobs processed in the last hour.
• Failed Jobs Past 7 Days: Offers insights into the stability and error rates of the system.
• Max Throughput: Tracks the system’s ability to handle tasks at peak load.

These statistics enable informed decision-making for system optimization.

5. Enhanced Debugging and Error Tracking

Horizon’s dashboard includes sections for reviewing:

• Pending Jobs: Tasks waiting to be processed.
• Completed Jobs: Successfully executed tasks.
• Failed Jobs: Errors encountered during job execution, with details for troubleshooting.
• Silenced Jobs: Jobs muted to avoid unnecessary alerts.

How Horizon is Used in PUQ Cloud

The Horizon module in PUQ Cloud is tailored to enhance the system’s automation capabilities by providing administrators with full control over background tasks. Key use cases include:

• System Maintenance: Scheduling and monitoring maintenance jobs, such as log cleanups and database optimizations.
• Notification Delivery: Ensuring timely dispatch of critical notifications to administrators or users.
• Error Resolution: Identifying and addressing issues in failed jobs to maintain service reliability.
• Performance Optimization: Analyzing queue metrics to adjust resource allocation and improve throughput.

Integration with PUQ Cloud Panel

The Horizon module seamlessly integrates with the PUQ Cloud Panel’s existing automation and monitoring features, creating a cohesive environment for managing system tasks. By providing real-time visibility and detailed analytics, Horizon ensures that the PUQ Cloud platform operates smoothly and efficiently.

Best Practices

To maximize the benefits of Horizon, administrators should:

• Regularly review queue statistics to identify and address performance bottlenecks.
• Optimize supervisor configurations to balance workloads effectively.
• Monitor failed jobs and implement fixes promptly to avoid service disruptions.
• Utilize metrics to forecast system requirements and scale resources accordingly.

Conclusion

The Horizon module is an indispensable tool within the PUQ Cloud Panel, providing unparalleled control and visibility over background task management. Its integration ensures that administrators can maintain system stability, optimize performance, and respond proactively to challenges, delivering a reliable and efficient platform for users.

Email & Notifications: Notification Senders Overview

PUQcloud Panel

Order Now | Download | FAQ

The Notification Senders section, located under Email & Notifications > Notification Senders, allows administrators to manage and configure modules responsible for sending notifications within the PUQ Cloud Panel. This section is a central hub for integrating, managing, and customizing notification delivery mechanisms. Each sender is tied to a specific module, providing flexibility and scalability in how notifications are handled.

Overview of the Notification Senders Page

The main page displays a list of available notification senders. Each entry includes the following attributes:

• Name: The name of the notification sender, providing an easily recognizable identifier for its function.
• Module: The specific module associated with the sender. For instance, modules such as PUQ Bell or PUQ PHPmail handle different notification delivery mechanisms.
• Description: A brief explanation, often set to "Created by system" for default senders.

The interface provides controls for managing senders:

• Edit: Opens the configuration page for the selected sender, allowing modifications.
• Delete: Removes the sender from the system, ensuring outdated or unused configurations do not clutter the interface.

Adding and Configuring Senders

By clicking the Create button, administrators can add new senders. The process involves selecting an appropriate module and providing necessary details based on the sender’s functionality. These configurations are tailored to the module’s capabilities, ensuring seamless integration with the system’s notification requirements.

Editing Notification Senders

Clicking the Edit button for a specific sender opens its configuration page. This page is dynamically generated by the associated module and may include various fields and settings depending on the sender’s purpose. Examples of configurations that might appear include:

• Email Settings: SMTP details, sender address, and authentication credentials for email-based notification modules.
• API Keys: Required for senders integrating with external services such as Twilio, Slack, or other third-party platforms.
• Custom Fields: Specific to the module, such as templates, message formats, or delivery rules.

The flexibility of these configurations ensures that each sender can be optimized to meet organizational requirements without affecting others.

Technical Details

The notification senders in PUQ Cloud Panel are modular by design. Each sender represents an independent module that integrates into the system’s notification framework. These modules handle the following core tasks:

• Message Formatting: Crafting notification messages in the required format, whether it is plain text, HTML, or a structured template.
• Delivery Mechanism: Handling the technical aspects of sending notifications, such as interacting with mail servers, pushing notifications to user devices, or sending API requests to external services.
• Error Handling: Logging failures and retrying delivery where necessary, ensuring reliable communication.

Integration with Notification Modules

Notification senders rely on the underlying modules to define their behavior. Each module implements the logic for its specific notification channel. Examples include:

• PUQ Bell: Handles internal system notifications, such as user alerts or task reminders, displayed within the PUQ Cloud Panel interface.
• PUQ PHPmail: A lightweight module for sending notifications via PHP’s mail function, suitable for basic email setups.
• Third-Party Integrations: Modules like Twilio or SendGrid extend functionality to external platforms, enabling SMS, push notifications, or advanced email services.

Usage and Best Practices

To maximize the effectiveness of the Notification Senders feature, consider the following best practices:

• Keep Configurations Up-to-Date: Regularly review and update sender settings to reflect changes in organizational needs or external service providers.
• Monitor Performance: Use system logs and dashboards to track delivery success rates and address issues promptly.
• Leverage Modular Flexibility: Enable or disable senders based on current requirements, ensuring only active channels consume system resources.

Conclusion

The Notification Senders section in PUQ Cloud Panel provides a robust framework for managing communication channels within the system. By leveraging modular integration, administrators can ensure that notifications are delivered effectively, tailored to specific needs, and aligned with organizational goals. The flexibility to configure, edit, and expand notification senders empowers organizations to maintain a streamlined and responsive communication strategy.

Email & Notifications: Notification Layouts Overview

The Notification Layouts section within the PUQ Cloud Panel, located under Settings > Email & Notifications, is a crucial feature for managing the design and structure of notifications sent through the system. This section provides the tools necessary for creating, editing, and deleting notification layouts, which serve as the foundation for email or system notifications. These layouts ensure consistent branding, readability, and functionality across all communication channels.

Overview of Notification Layouts

Upon accessing the Notification Layouts page, users are presented with a table that displays the following details for each layout:

• Name: The unique identifier for the layout, such as "Admin Default Layout" or "Client Default Layout."
• Description: A brief explanation of the layout’s purpose or its creation context, e.g., "Created by system."

The interface allows for efficient management of layouts with the following actions:

• Create New Layouts: Add a new notification layout tailored to specific branding or communication needs.
• Edit Existing Layouts: Modify the content or structure of an existing layout to adapt to evolving requirements.
• Delete Layouts: Remove unused or obsolete layouts to maintain clarity and organization.

Detailed Breakdown of the Layout Editing Page

Clicking the edit button for a layout opens a detailed editor. The editor is divided into sections for configuring the layout’s content and appearance. Key features of the editing page include:

1. General Information

• Name: The editable name of the layout, which helps identify its purpose or scope.
• Description: A text field for providing a brief summary of the layout’s role or customization details.

2. Language Support

The layout editor supports multiple languages, aligned with the languages configured in the PUQ Cloud Panel. Users can toggle between language tabs (e.g., English, Ukrainian, Polish) to customize the content for specific audiences, ensuring localization and inclusivity in communication.

3. Code Editor

The primary area of the editor contains a robust HTML code editor, where users can:

• Write or Modify Code: Directly input HTML and CSS to define the layout structure and styles.
• Utilize Dynamic Variables: Integrate placeholders like {{ $title }} or {{!! $content !!}} to dynamically populate content during runtime.
• Preview Changes in Real-Time: As users update the code, the right-hand panel displays a live preview of the layout, allowing for immediate feedback on design adjustments.

4. Real-Time HTML Preview

On the right-hand side of the editor, the live preview provides a visual representation of the layout, showcasing how the notification will appear to recipients. This feature enhances the design process by reducing errors and improving efficiency.

Advanced Features and Flexibility

The Notification Layouts section is built to accommodate diverse organizational needs with advanced features:

• Custom Styling: Leverage inline CSS and advanced design techniques to create visually appealing notifications.
• Template Sharing: Easily duplicate layouts for reuse or share them across different modules and use cases.
• Integration with Notification Templates: Use layouts as a foundation and pair them with notification templates to deliver tailored messages with consistent design.

Use Cases and Benefits

The Notification Layouts feature is highly versatile, offering solutions for various communication scenarios:

• Branded Notifications: Ensure all emails and system notifications align with organizational branding guidelines.
• Localized Communication: Provide content in multiple languages to cater to diverse user bases.
• Efficient Design Management: Centralize the management of notification designs, reducing development overhead.

Conclusion

The Notification Layouts section in the PUQ Cloud Panel empowers administrators to design, customize, and manage notification layouts effectively. By providing a comprehensive editing interface with live preview capabilities and multilingual support, this feature ensures organizations can deliver consistent, professional, and localized communication to their users. Its integration with other notification tools within the panel further enhances its utility, making it an indispensable component of the PUQ Cloud ecosystem.

Email & Notifications: Notification Templates

PUQcloud Panel

Order Now | Download | FAQ

The "Notification Templates" section in the PUQ Cloud Panel under Email & Notifications is designed for creating and managing the content of emails and notifications that the system sends to clients and staff. This feature allows administrators to customize the content, structure, and language of templates to align with business needs.

Main Page Overview

The main Notification Templates page displays a table with the following details:

• Name: The title of the notification template, such as "Admin Failed Login Attempt" or "Welcome Email."

• Category: Specifies the type of notification, such as "Staff Operational" or "Staff Administrative."

• Status: Indicates whether the template is a system default or custom. System templates are pre-configured and may require administrative privileges for modification.

• Actions:

  • Edit: Opens the template editor for customizing content and settings.

  • Delete: Removes the template from the system, ensuring it is no longer used for notifications.

The page also features a Create button that allows administrators to design new notification templates from scratch. Additionally, the search bar enables users to quickly locate templates by name or category.

Editing a Notification Template

Upon clicking the edit button for a template, the user is taken to the Edit Notification Template page, which is divided into the following sections:

1. General Information

• Name: The title of the template, editable to reflect its purpose.

• Category: Defines the operational context of the notification, ensuring it aligns with organizational workflows.

2. Language Support

The editor supports all languages configured in the PUQ Cloud Panel, enabling multi-language customization for global audiences.

• Tabs for Each Language: Users can switch between languages (e.g., English, Ukrainian, Polish) to define specific content for each locale.

• This ensures that recipients receive notifications in their preferred or configured language, enhancing clarity and user experience.

3. Content Sections

• Subject: The title or subject line of the email/notification. This field is crucial for capturing the recipient's attention.

• Text:

  • Full Text: Designed for long-form notifications, such as emails. It supports rich formatting and HTML for creating visually appealing messages.

  • Mini Text: A condensed version of the message, used for SMS, in-app notifications, or alerts in the panel's notification bell. This ensures brevity while conveying essential information.

4. HTML Preview

On the right-hand side, an HTML Preview dynamically updates as the user modifies the template content. This real-time feature allows administrators to see how the notification will appear to recipients, reducing the likelihood of formatting errors.

Customization Examples

• Welcome Email:

  • Full Text: Provides a detailed message welcoming new administrators, including a link to log in and additional guidance.

  • Mini Text: A short notification stating, "Welcome, [Admin Name]! Log in to your dashboard here: [Link]."

• Admin Failed Login Attempt:

  • Full Text: Alerts the administrator with details of the failed login, including the time, IP address, and username.

  • Mini Text: "Failed login detected for [Username]. Check logs for details."

Benefits of Multi-Language and Dual-Text Support

• Global Reach: Ensures inclusivity and effective communication with a diverse user base.

• Adaptability: Provides flexibility for various notification channels, from detailed emails to succinct SMS messages.

• Real-Time Feedback: The preview pane eliminates the need for external tools, streamlining the editing process.

Best Practices for Using Notification Templates

• Define Clear Categories: Organize templates into logical categories to improve manageability and consistency.

• Leverage Language Tabs: Ensure all supported languages have accurate and professional translations.

• Utilize Previews: Regularly review the HTML preview to confirm alignment, font styles, and overall layout.

• Test Templates: Send test notifications to validate how they appear in different channels, such as mobile devices and email clients.

Conclusion

The Notification Templates feature in the PUQ Cloud Panel is a powerful tool for creating tailored notifications that enhance communication and user experience. With its multi-language support, dual-text options, and dynamic preview, administrators can efficiently manage and optimize system notifications to meet organizational and user expectations.

General: General Settings

PUQcloud Panel

Order Now | Download | FAQ

The "General" section of the PUQ Cloud Panel, found under Settings > General, provides essential configurations for the system's operation. This section is divided into two main tabs: Time Based and Social. Each tab offers specific fields and settings tailored for managing system logs and social media integration.

Time Based Tab

The Time Based tab focuses on defining retention periods for various logs and histories. This ensures efficient management of data while maintaining system performance and compliance requirements. Below are the fields and their functions:

• Admin Session Log History:
  • Description: Sets the number of days to retain logs of administrator sessions.
  • Purpose: Useful for auditing administrator activities and maintaining a history of access logs.
• Client Session Log History:
  • Description: Specifies the retention period for logs of client sessions.
  • Purpose: Enables tracking and reviewing client access for operational and security purposes.
• Activity Log History:
  • Description: Determines how long system activity logs are stored.
  • Purpose: Helps monitor system-wide events and troubleshoot issues effectively.
• Module Log History:
  • Description: Defines the retention duration for logs related to module actions.
  • Purpose: Essential for reviewing module performance and debugging.
• Notification History:
  • Description: Configures the number of days to keep logs of notifications sent by the system.
  • Purpose: Ensures accountability and helps resolve notification-related issues.
• Task Queue History:
  • Description: Specifies how long task queue logs should be retained.
  • Purpose: Provides insights into task executions and supports debugging.
• Completed Task Queue History:
  • Description: Sets the retention period for completed tasks in the queue.
  • Purpose: Helps maintain an overview of successfully executed tasks.

Social Tab

The Social tab enables the integration of social media and communication platforms, allowing users to link their profiles and maintain a consistent online presence. Below are the fields available in this tab:

• Facebook: Enter the profile or page URL.
• Instagram: Provide the username or profile link for Instagram.
• Twitter: Add the Twitter handle or URL.
• YouTube: Include the channel URL for YouTube.
• LinkedIn: Enter the company page URL for LinkedIn. (Individual profiles are not supported.)
• GitHub: Provide the GitHub username or profile link.
• WhatsApp: Specify the registered phone number for WhatsApp, including the country code.
• Telegram: Input the Telegram username or phone number.
• Viber: Enter the Viber username or phone number.
• Discord: Provide the invite URL for Discord servers or groups.
• Reddit: Add the profile or community URL for Reddit.
• Flickr: Include the profile link for Flickr.
• Skype: Specify the Skype username.
• Slack: Enter the Slack workspace ID.
• BitBucket: Add the username or URL for BitBucket.
• Gitter: Provide the Gitter chat room or profile URL.
• Vimeo: Include the profile URL for Vimeo.

Conclusion

The "General" section is pivotal for configuring the system's operational and social settings. With its comprehensive fields in Time Based and Social tabs, administrators can maintain optimal log retention policies and integrate social platforms seamlessly. This ensures streamlined operations and enhanced connectivity with clients and stakeholders.

General: Countries

PUQcloud Panel

Order Now | Download | FAQ

The "Countries" section within the General menu of the PUQ Cloud Panel provides a comprehensive overview and management interface for countries recognized by the system. This section plays a crucial role in enabling accurate regional settings, localized configurations, and communication requirements for various modules and functionalities.

Overview

The "Countries" section displays a list of countries with the following details for each entry:

• Flag: A visual representation of the country’s flag, aiding in quick identification.
• Code: The standardized two-letter ISO code for the country, essential for international referencing.
• Name: The full name of the country in English, often accompanied by the native script if applicable. This ensures clarity and inclusivity for multilingual users.
• Calling Code: The international dialing code for the country, utilized for telecommunications and notification modules involving phone numbers.
• Regions: The number of administrative or geographical regions associated with the country, facilitating detailed localization and specific targeting.

Features and Functionalities

• Pagination: The list supports pagination, as indicated by the numbered pages at the bottom. This allows users to navigate through a large dataset efficiently, especially when managing entries for all 248 countries.
• Search Functionality: A search bar is available in the top-right corner, enabling quick filtering of countries by any visible attribute such as name, code, or calling code.
• Detailed View: Each country entry includes an action button (“View”) on the far-right side, allowing administrators to access additional information or modify region-specific settings.

Purpose and Usage

The "Countries" section is primarily utilized for:

• Localization: Configuring system behavior and settings based on the user’s or client’s geographic location.
• Telecommunications: Using calling codes for notifications, SMS, or VoIP integrations.
• Region Management: Associating regions with countries for more granular control over localization requirements.

Integration with Other Modules

This section is tightly integrated with other functionalities in the PUQ Cloud Panel. For example:

• The "Currencies" section utilizes country data to associate specific currencies with respective countries.
• The "Notification" module may leverage calling codes when sending SMS or other notifications to users.

Details from Files

Based on the project files:

• Data Source: The country list is pre-populated based on the ISO 3166 standard, ensuring comprehensive global coverage and compatibility with international systems.
• Customization: Administrators can modify region-related data and link custom functionalities or modules to specific countries, enhancing flexibility.
• Scalability: The system supports the addition of new countries or regions if required, ensuring adaptability to future needs.

Conclusion

The "Countries" section in the PUQ Cloud Panel is a vital feature that underpins the system’s localization and internationalization capabilities. Its user-friendly interface, combined with robust integration and customization options, ensures seamless management of country-specific settings across various modules. This flexibility and comprehensiveness make it an indispensable tool for administrators managing a globally diverse user base.

General: Currencies

PUQcloud Panel

Order Now | Download | FAQ

The "Currencies" section under General in the PUQ Cloud Panel provides a comprehensive interface for managing currency settings used across the system. This section allows administrators to configure, edit, and manage multiple currencies efficiently. Below is a detailed explanation of the interface and its functionalities as seen in the provided screenshot.

Overview of the Currencies Table

The main table displays all available currencies with the following columns:

• Code: The ISO 4217 currency code (e.g., USD for US Dollar, EUR for Euro) used as a unique identifier for each currency.
• Prefix: The symbol or text that appears before the currency amount (e.g., $ for USD, € for EUR).
• Suffix: Optional text or symbols displayed after the currency amount.
• Default: Indicates the system's primary currency. Only one currency can be marked as default at a time. The default currency is highlighted with a green checkmark, while others show a red cross.
• Format: Displays the numerical formatting style for currency values (e.g., "1,234.56" or "1.234,56"). This ensures clarity for different regional preferences.
• Base Conversion Rate: The conversion rate relative to the default currency. For example, if USD is the default currency and the rate for EUR is 0.9, then 1 EUR equals 0.9 USD.
• Actions: Provides options to Edit or Delete a currency. Editing allows administrators to update any field, while deleting removes the currency from the system.

Functionalities

The "Currencies" section supports the following key functionalities:

• Adding a New Currency:
  • Administrators can add a new currency by clicking the "+ Create" button in the top-right corner.
  • This opens a form where all required fields, including Code, Prefix, Suffix, Format, and Base Conversion Rate, can be specified.
• Editing Existing Currencies:

  

   
  • Clicking the yellow "Edit" button allows administrators to modify any attribute of a currency. This is particularly useful for updating conversion rates or changing format styles.
  • The editing form contains the following fields:
    • Code: The ISO 4217 code for the currency.
    • Prefix: Symbol or text displayed before the currency value.
    • Suffix: Text or symbols displayed after the currency value.
    • Exchange Rate: The conversion rate relative to the default currency.
    • Format: Choose the numerical format for currency values (e.g., "1,234.56").
    • Default: Checkbox to set the currency as the default.
• Deleting Currencies:
  • The red "Delete" button permanently removes a currency from the system. This action is irreversible and should be performed with caution.
• Setting the Default Currency:
  • Administrators can designate a currency as the default by editing it and enabling the "Default" option. This currency will be used as the base for all conversion calculations.

Key Details

The "Currencies" section is designed to handle multiple use cases, including:

• Multi-Currency Support: Enable businesses to operate in different regions by offering localized pricing.
• Custom Formatting: Adapt currency displays to match user expectations based on locale and regional standards.
• Efficient Management: Streamline the process of maintaining up-to-date exchange rates and ensuring accurate financial records.

Conclusion

The "Currencies" section in the PUQ Cloud Panel provides a robust and user-friendly interface for managing financial settings. Its ability to support multiple currencies, coupled with flexible formatting options and seamless integration, makes it an essential tool for businesses operating in global markets. By leveraging this section, administrators can ensure consistent and accurate currency handling across the system.