The AI-Native Device Platform
User Manual

Edit Project

This page allows you to manage Smart Automization projects, including creating new ones, loading existing ones, and configuring various settings such as project name, description, execution schedule, messaging preferences, environment variables, and agent prompts.

Edit Project

Summary

The 'Edit Project' page is your central hub for configuring Smart Automization projects. Here, you can create new projects or modify existing ones by adjusting settings like the project's name, description, execution frequency, communication preferences, environment variables, and how its intelligent agent operates. It's designed to give you full control over your automation routines, from simple tasks to complex orchestrations.

awaBerry Anywhere Markdown Editor

The awaBerry Anywhere Markdown Editor is a versatile tool for managing Markdown content. It offers three distinct viewing modes: Editor, Split, and Preview, allowing users to focus on writing, view both code and live output, or solely see the formatted result. The editor automatically saves content periodically if the user is active and can also be manually saved. It also includes integrated session management features that notify users when their session is about to expire or has already expired, prompting necessary actions to maintain access.

Generate project execution logic

The 'Generate project execution logic' page is a central hub for managing your project's automated tasks. It provides a real-time terminal to view ongoing processes, dynamic screenshots to visualize progress, and a detailed log of all activities. This ensures you have complete oversight of your project's setup and execution. The system also keeps you informed about your user session status, providing timely warnings before your session expires and clear notifications if it does.

Execute project logic

This page provides a comprehensive interface for overseeing your project's setup and ongoing activities. You will see real-time output in a terminal, updates on your project's status, and live screenshots as tasks progress. The system will also notify you about your session's status, such as when it's about to expire or has expired, to ensure you can manage your work without interruption.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

This page provides comprehensive tools to manage your automation projects:

  • Project Name & Description: Easily set or modify the name and a detailed description for your project.
  • Environment Variables: Define and manage key-value pairs for environment settings specific to your project. You can add, edit, or remove variables, toggle their visibility for security, and even link to other projects as references.
  • Agent Type: Choose between two agent types:
    • Single Agent: For direct execution tasks, where you define a primary prompt for the agent to follow.
    • Executor Agent: For orchestrating multiple projects. You define the order in which referenced projects are executed. Projects can be added, removed, and reordered.
  • Project Activation: A toggle switch to activate or deactivate your project. Inactive projects will not run according to their schedule.
  • Display in Portal: A checkbox (available for 'Single' agent types) to control whether your project is visible on the main portal page.
  • Download Project JSON: Export your project's configuration as a JSON file, including placeholders for sensitive environment variable values.
  • Execution Schedule: Set when your project runs:
    • Never: No automated execution.
    • Daily: Select specific days and hours for daily execution.
    • Weekly: Choose a specific day of the week for execution.
  • Messaging Preference: Select how you want to receive or send messages after project execution (e.g., Email, Slack, X.com/Twitter). If you choose Slack or X.com, the system will automatically add the necessary environment variables for you to fill in.
  • Execution Setup Status: Monitor the status of your project's execution environment.
    • Create Execution Setup: Initialize the execution environment for a new project.
    • Recreate Execution: Rebuild the execution environment (recommended after significant prompt changes).
    • Update Result: Trigger an immediate update of the project's execution result.
    • View Last Result (HTML): See the most recent HTML output from your project's execution.
    • View Last Result (JSON): Access the raw JSON data from the last project run.
    • Show Latest Gemini Log: Review the detailed log of the most recent Gemini execution for debugging or review.
  • Save Project: Commit all your changes to the project configuration.
  • Back Button: Navigate back to the previous screen. If you have unsaved changes, you'll be prompted to save, discard, or continue editing.

Scenario Executions

Possible usage steps within this page

Scenario: Successfully Create and Configure a New Single Agent Project

This scenario guides you through creating a new project, setting its basic details, adding an environment variable, and configuring its execution and messaging.

  • Project Name: My New Automation
  • Project Description: Automates daily report generation.
  • Main Prompt: Generate report, save to /output.
  • Environment Variable Key: API_KEY
  • Environment Variable Value: your_api_key_here
  1. Click the 'Create new project' button (or navigate to create a new project).
  2. Enter "My New Automation" into the 'Project Name' field.
  3. Enter "Automates daily report generation." into the 'Project Description' field.
  4. Enter "Generate report, save to /output." into the 'Prompt' text area.
  5. Scroll to the 'Variables' section and click the '+' (add) button.
  6. Enter "API_KEY" into the 'Key' field of the new environment variable.
  7. Enter "your_api_key_here" into the 'Value' field of the new environment variable.
  8. In the 'Execution' section, ensure 'Daily' is selected, and choose specific days and hours if desired (e.g., 'Mon-Fri' at '9 am').
  9. In the 'Messaging' section, select 'Email'.
  10. Click the 'Save' button.

Goal: The project is successfully saved with a new project ID, and you receive a "Project saved successfully" notification.

Scenario: Update an Existing Project's Execution Schedule

This scenario demonstrates how to modify the execution frequency of an already created project.

  • Existing Project ID: project_12345 (assume this project is loaded)
  • New Execution Mode: Weekly
  • New Day: Monday
  1. Load an existing project (e.g., by selecting it from the project overview).
  2. Navigate to the 'Execution' section.
  3. From the execution mode dropdown, select 'Weekly'.
  4. In the day selector, ensure only 'Mon' is selected.
  5. Click the 'Save' button.

Goal: The project's execution schedule is updated to run weekly on Monday, and you receive a "Project saved successfully" notification.

Scenario: Configure Slack Messaging and Verify Environment Variable Addition

This scenario shows how selecting Slack messaging automatically prompts for the required webhook environment variable.

  • Existing Project ID: project_67890 (assume this project is loaded and does NOT have SLACK_WEBHOOK yet)
  1. Load an existing project.
  2. Navigate to the 'Messaging' section.
  3. From the messaging dropdown, select 'Slack message'.
  4. Observe the environment variables section.
  5. You will see a snackbar notification: "Set the variable SLACK_WEBHOOK to receive messages via slack".

Goal: The 'SLACK_WEBHOOK' environment variable key is automatically added to the environment variables list, awaiting its value.

Scenario: View Last HTML Execution Result

This scenario details how to retrieve and display the HTML output from the most recent project execution.

  • Existing Project ID: project_abcde (assume this project is loaded and has at least one execution result)
  1. Load an existing project that has been executed at least once.
  2. Scroll to the 'Execution Setup' section.
  3. Click the 'Last Result' button (looks like a history icon).
  4. A loading dialog will appear, followed by a full-screen view of the HTML result.

Goal: A new full-screen window opens, displaying the HTML content of the last execution result.

Possible errors which may occur on this page

Error: Attempt to Switch to Executor Agent Type with No Available Projects

Description: When trying to change the 'Agent Type' to 'Executor' without any other projects created that can be referenced, the system prevents the switch and informs the user.

Steps to Reproduce:

  1. Load any project (or create a new one). Ensure no other projects exist in the system besides the current one (i.e., the 'Projects' list in the SmartAutomizationEditProject widget is empty or only contains the current project).
  2. Navigate to the 'Agent Type' section.
  3. From the dropdown, attempt to select 'Executor'.

Expected Outcome: A snackbar notification appears stating: "Creating an orchestrator requires at least one project it can execute - create an execution project first." The agent type dropdown remains unchanged.

Error: Saving Project with Missing Environment Variable Values

Description: If you attempt to save a project that has environment variables defined but some of their 'Value' fields are left empty or contain the placeholder "place value here", the save operation will not proceed successfully for execution setup purposes, and you will see a warning.

Steps to Reproduce:

  1. Load any existing project or create a new one.
  2. In the 'Environment Variables' section, add a new variable or ensure an existing variable has an empty 'Value' field (or "place value here").
  3. Attempt to click the 'Save' button.

Expected Outcome: A warning box appears in the 'Execution Setup' section indicating: "At least one value for an environment variable is missing - add them and save project to add / recreate the execution for this project". The save operation will still complete for the project's basic details, but any execution-related actions will be disabled until all environment variables are filled.

Navigate ← Project Overview ← Smart Automization Framework - Setup ← awaBerry Platform Overview ← awaBerry User Manual Main Page