Web Interface

The Web Interface module provides a web-based control panel for the Anteater application. It allows users to access logs and manage recipe execution through a web browser. While it offers convenient remote access, it has limited functionality compared to the desktop version, lacking advanced features like the recipe editor and debugging tools.

The Anteater Web Application requires ae.jar file to function properly.

Please ensure that ae.jar file is downloaded and placed in the same folder as anteater-web.jar.

Without ae.jar file, the Anteater Web Application will not work correctly.

How to run

Run command:

$ java -jar anteater-web.jar

If you use a classpath definition, ensure you run the spring-boot main class: org.springframework.boot.loader.JarLauncher:

$ java -cp anteater-web.jar;ae.jar;plugins/*.jar org.springframework.boot.loader.JarLauncher

Desktop UI

Endpoints Overview

The following table lists the key endpoints available in the Anteater application, along with their descriptions. These endpoints provide access to various features and functionalities, enabling users to interact with the application effectively. Each endpoint serves a specific purpose, ranging from managing inputs to monitoring logs and executing tasks.

Path Description
/dashboard Displays the main dashboard interface, providing an overview of the application.
/input-array Handles input operations for arrays, allowing users to submit or manipulate array data.
/input Accepts general input for the application, such as variables or configurations.
/run Executes the specified recipe or task within the application.
/menu Displays the menu interface, allowing navigation between different application sections.
/show Presents detailed information or results based on the selected task or recipe.
/view.* Provides dynamic views for specific components or modules (e.g., logs, records).
/record Manages record operations, such as creating, updating, or viewing records.
/task-log Displays logs specifically related to executed tasks for debugging purposes.
/log Shows general application logs for monitoring and troubleshooting.

  • Dynamic Views (/view.*): The /view.* endpoint is highly flexible and supports rendering views for various application components. This includes logs, records, and other dynamically generated content based on the user's interactions or system state.

  • Logs and Monitoring: The /task-log and /log endpoints are essential for debugging and monitoring. While /task-log focuses on task-specific logs, /log provides a broader view of application-level logs, helping users identify and troubleshoot issues effectively.

  • Interactivity and Customization: Endpoints like /input-array and /input allow users to provide input data dynamically, making the application adaptable to various workflows. These endpoints are particularly useful for scenarios requiring real-time configuration or variable management.

  • Recipe Execution: The /run endpoint is a critical feature for executing recipes or tasks. It ensures that workflows defined in Anteater are carried out seamlessly, whether for automation, testing, or other use cases.

  • Navigation: The /menu and /dashboard endpoints serve as the primary navigation and control hubs, offering a user-friendly interface for exploring the application's features.

These endpoints collectively make Anteater a versatile and powerful tool for automation, testing, and system management. By leveraging these paths, users can efficiently interact with the application and streamline their workflows.

Customizing Anteater Web Application Views

The Anteater web application interface is highly customizable to suit specific requirements. If needed, you can create alternative customized views by modifying files in the web folder located in the working directory. This allows you to tailor the appearance and functionality of the web application according to your needs.

Default Directory Structure

The default structure of the web folder is organized as follows:

web
 ├───static
 └───templates

(see: anteater-web/src/main/resources/web)

Directory Breakdown:

  1. web/static:

    • Contains static resources such as HTML, images, CSS, and JavaScript files.
    • The img subfolder holds images used in the web application.

  2. web/templates:

    • Houses freemarker templates for the web application.
    • The view subfolder contains template files for rendering specific views in the application.

How to Customize Views

  1. Create or Modify Files:

    • Add new freemarker templates in the web/templates/view folder for customized rendering.
    • Replace or extend static resources (e.g., images, CSS) in the web/static folder.

  2. Update Configuration:

    • Ensure the application is configured to use the customized views by referencing the updated files in your recipes or settings.

  3. Preview Changes:

    • Restart the Anteater web application to apply and preview your customizations.

Benefits of Customization

  • Tailored User Experience: Create views that better align with your workflow or branding.
  • Enhanced Functionality: Add custom elements or features to improve usability.
  • Flexibility: Adapt the web application to specific organizational or project requirements.

By leveraging the customizable web folder structure, you can create a fully personalized web interface for the Anteater application while maintaining the flexibility and power of its core functionality.