The AI-Native Device Platform
User Manual

Project Overview

This page allows you to view, create, edit, delete, and manage your smart automation projects. It provides quick access to application settings and a consolidated view of your portal projects.

Project Overview

Summary

This page allows you to view, create, edit, delete, and manage your smart automation projects. Each project has a unique identifier, an activation status, a name, an optional summary, details about its last execution, and can reference other projects. You can also decide if a project's summary should be displayed on your personal portal page. The page provides quick access to application settings and a consolidated view of your portal projects.

Create project

This page is your starting point for creating new Smart Automization projects. You have three main ways to begin: upload an existing project from a JSON file, describe your project idea to an AI that will then set up the details, or simply create an empty project to build manually. Projects can interact with various resources like files, folders, databases, and web services by using environment variables. Every project involves two key stages: first, defining the project and letting our system generate the necessary scripts, and second, running these scripts either on a schedule or as part of a larger automated process. The execution phase is designed to be efficient, often running without needing to call AI models, or using more cost-effective models when AI input is required.

Edit Project

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.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

Top Bar Controls:

  • Smart Automation Projects (Title): Clearly indicates that you are on the page dedicated to managing your automation projects.
  • Search Projects (Magnifier icon): Click this icon to open a search bar, allowing you to quickly filter your projects by name.
  • Show Portal HTML Summary (Pages icon): This button generates and displays a full-screen view of your projects' summaries as they would appear on your personalized web portal.
  • Smart Automation Settings (Gear icon): Navigates you to a dedicated settings page where you can configure advanced options for your automation framework, such as how your portal pages are published (e.g., to a local folder or cloud storage).
  • Refresh Projects (Refresh icon): Use this to reload the list of projects, ensuring you always have the most current information.

Project List Area:

  • Smart Automation Framework Description: A brief text explaining the capabilities of the automation framework and assuring you that project configurations are stored only on your device.
  • Add New Project Button: A prominent orange button that initiates the process of creating a new smart automation project. You can choose to upload a project from a JSON file, generate project details using an AI agent based on your prompt, or start with an empty project by providing a name.
  • Executor Projects Section: This section displays projects designated as 'executor' types in a distinct, full-width card format. These projects typically manage and orchestrate other automation tasks. Each executor project card includes:
    • Executor Icon (Hub): A visual indicator for executor projects.
    • Project Name: The main title of the project.
    • Last Execution Date: The timestamp of when the project was last run, if available.
    • Summary: A brief description or result summary of the project's most recent activity.
    • Active Toggle Switch: Allows you to enable or disable the project's automation. When active, its tasks will run according to its schedule.
    • Referenced Executor Projects: A list of other projects that this executor project depends on, with a note clarifying their execution order.
    • Edit Button (Pencil icon): Opens the project editing screen to modify the project's configuration.
    • Delete Button (Trash can icon): Prompts for confirmation then permanently removes the project.
  • List of all projects Section: This section presents all other project types in a responsive tiled layout. Each project card includes:
    • Portal Display Icon (Pages icon, if present): Indicates if the project's summary is configured to be displayed on your personal HTML portal.
    • Project Name: The title of the project.
    • Active Toggle Switch: To enable or disable the project's automation tasks.
    • Last Execution Result & Summary: Information about the project's last run and a brief summary of its outcome, if any. If not yet executed, it will state so.
    • Referenced Projects: A list of other projects that this project relies on.
    • Edit Button (Pencil icon): Opens the project editing screen for making changes.
    • Delete Button (Trash can icon): Prompts for confirmation then permanently removes the project.

Scenario Executions

Possible usage steps within this page

View Existing Projects (Test_1)

  • Goal: To see a list of all configured smart automation projects, each with its name, status, and latest activity.
  • Steps:
    1. Navigate to the Smart Automation Projects page.
    2. Observe the main area of the page.

Create a New Project (Test_2)

  • Proposed Input Variable: projectName (e.g., "My New Automation Project")
  • Goal: To successfully create a new smart automation project and see it listed in the overview.
  • Steps:
    1. Click the 'Add new project' button (the large orange button).
    2. On the new screen, choose your desired creation method (e.g., 'Start with an empty project').
    3. Enter a 'Project Name' (e.g., 'My New Automation Project').
    4. Complete any other necessary details and save the project.
    5. Return to the Smart Automation Projects overview page.

Edit an Existing Project (Test_3)

  • Proposed Input Variables: existingProjectName (e.g., "Daily Report Generator"), newDescription (e.g., "This project now generates a detailed report daily.")
  • Goal: To update the details of an existing project and see the changes reflected on the overview page.
  • Steps:
    1. Locate the project you wish to edit (e.g., 'Daily Report Generator') in the list.
    2. Click the 'Edit Project' icon (pencil icon) on the project's card or click anywhere on the project card/row itself.
    3. On the project editing screen, modify the desired fields (e.g., update the 'Project Description' to 'This project now generates a detailed report daily.').
    4. Save your changes and return to the Smart Automation Projects overview page.

Toggle Project Active Status (Test_5)

  • Proposed Input Variable: projectName (e.g., "Weather Monitor Project")
  • Goal: To activate or deactivate a project, controlling whether its automation tasks will run.
  • Steps:
    1. Locate the project (e.g., 'Weather Monitor Project').
    2. Click the toggle switch next to the project's name.
    3. Observe the 'Updating project status...' dialog that appears briefly.
    4. Observe the state of the toggle switch.

View Portal HTML Summary (Test_6)

  • Goal: To view a compiled HTML page summarizing the selected projects' outputs, as configured for your personal portal.
  • Steps:
    1. Click the 'Show Portal HTML Summary' icon (pages icon) in the top bar.
    2. Observe the 'Loading portal summary...' dialog.
    3. A new full-screen window will appear.

Access Smart Automation Settings (Test_7)

  • Goal: To navigate to the application settings page where you can configure how your portal pages are published (e.g., local folder, cloud storage).
  • Steps:
    1. Click the 'Smart Automation Settings' icon (gear icon) in the top bar.
    2. A new full-screen settings page will appear.

Search for a Project (Test_8)

  • Proposed Input Variable: searchQuery (e.g., "Daily Report")
  • Goal: To quickly find specific projects by filtering the list based on their names.
  • Steps:
    1. Click the 'Search projects' icon (magnifier icon) in the top bar.
    2. In the search bar that appears, type your search query (e.g., 'Daily Report').
    3. Observe the project list being filtered to show only matching projects.
    4. To clear the search, click the 'Close search' icon (X icon) in the search bar.

Possible errors which may occur on this page

View Existing Projects (Test_1 - Error)

  • Occurring error: The page displays 'Error: [error details]' or an empty list when projects are expected.
  • Why it happens: This typically indicates a problem connecting to your device or an issue retrieving project data.

Create a New Project (Test_2 - Error)

  • Occurring error: You are redirected to an upgrade page instead of the project creation screen, or the project fails to save.
  • Why it happens: You might have reached the maximum number of projects allowed by your current license. If saving fails, it could be due to network issues.

Edit an Existing Project (Test_3 - Error)

  • Occurring error: Your changes are not saved, or an error message appears after attempting to save.
  • Why it happens: This can occur if there are network issues preventing the updates from being applied to your device.

Delete a Project (Test_4 - Error)

  • Proposed Input Variable: projectToDelete (e.g., "Old Test Project")
  • Goal: To permanently remove a project from your list of smart automation projects.
  • Steps:
    1. Locate the project you wish to delete (e.g., 'Old Test Project').
    2. Click the 'Delete project' icon (trash can icon) on the project's card.
    3. A confirmation dialog will appear. Click 'Delete' to confirm.
    4. Observe the project list.
  • Occurring error: A 'Failed to delete project' message appears, and the project remains in the list.
  • Why it happens: This usually indicates a network error during the deletion process or an issue on your device preventing the project from being removed.

Toggle Project Active Status (Test_5 - Error)

  • Occurring error: The toggle switch reverts to its previous state after attempting to change it, and an 'Error updating project status' message appears.
  • Why it happens: A network issue is preventing the status update from being communicated to your device.

View Portal HTML Summary (Test_6 - Error)

  • Occurring error: A 'Failed to load portal summary' error message appears, and the summary page does not open.
  • Why it happens: This can be due to network problems, or an issue on your device preventing the generation or retrieval of the HTML summary.

Search for a Project (Test_8 - Error)

  • Occurring error: After typing a search query, the project list becomes empty even though you expect matching projects to exist.
  • Why it happens: The search query might be misspelled or the project name you are looking for does not exactly match the typed text. Ensure your search query is accurate.
Navigate ← Smart Automization Framework - Setup ← awaBerry Platform Overview ← awaBerry User Manual Main Page