User Manual

Create project

This page allows you to start new Smart Automization projects using three different methods: by uploading a project file, by describing your project idea for an AI to set up, or by starting with a blank project and naming it yourself. It also helps manage your active session by alerting you before it expires or if it has already ended.

Create project

Summary

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.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

This page offers three ways to initiate a new automation project:

Option 1: Upload from JSON

This option allows you to import an existing project from a JSON file saved on your device. Upon successful upload, the project details will be loaded into the editing screen, ready for further configuration.

  • "Upload Project JSON" Button: Click this button to open a file browser and select a .json file that contains your project's definition.

Option 2: Generate with AI

Use this method to describe your project idea in natural language, and an Artificial Intelligence (AI) agent will generate the initial project setup for you. This is ideal for quickly bootstrapping a project from a conceptual idea.

  • Project Idea Text Field: Enter a detailed description of your project's goal. It's recommended to provide at least 16 words for best results.
  • "Generate Project" Button: After entering your idea, click this button to start the AI generation process. A loading indicator and a progress bar will appear, showing that the AI is working. This process can take up to 2 minutes.
  • Loading Indicator and Progress Bar: These visual cues inform you that the AI is actively processing your request.

Option 3: Generate Empty Project

If you prefer to build your project from the ground up, this option creates a blank project where you can manually define all details. You only need to provide a name to get started.

  • "Project name" Text Field: Enter a descriptive name for your new project.
  • "Create Empty Project" Button: Click this button to create an empty project with the name you provided, and you will be directed to the project editing screen.

Additionally, the page incorporates session management, providing notifications if your user session is about to expire or has already expired, to ensure you can save your work and log back in if necessary.

Scenario Executions

Possible usage steps within this page

Upload Project from JSON

  • Scenario: Successfully upload a valid project JSON file.
    1. Click the "Upload Project JSON" button.
    2. Select a valid .json file from your local machine.
    3. The project data will be processed, and you will be directed to the project editing screen with the uploaded details pre-filled.

Generate Project with AI

  • Scenario: Successfully generate a project using a detailed AI prompt.
    1. In the "Describe the goal of your project" text field, enter a clear and detailed description of your project idea (at least 16 words).
    2. Click the "Generate Project" button.
    3. Observe the loading indicator and progress bar as the AI processes your request.
    4. Once complete, you will be directed to the project editing screen with the AI-generated project details.

Generate Empty Project

  • Scenario: Successfully create a new empty project.
    1. In the "Project name" text field, enter a desired name for your new project.
    2. Click the "Create Empty Project" button.
    3. An empty project with your specified name will be created, and you will be taken to the project editing screen.

Possible errors which may occur on this page

Upload Project from JSON Errors

  • Error: "Error parsing JSON: {e}"

    Reason: This error occurs if the file you selected is not a correctly formatted JSON file, or if it's corrupted. The system cannot understand the content.

  • Error: "Missing required fields: [field1, field2]"

    Reason: Even if the file is valid JSON, it might be missing essential information like the project name, description, or agent type that are needed to create a project. You need to ensure the JSON file contains these crucial details.

Generate Project with AI Errors

  • Error: "Please provide at least 16 words to describe your project goal"

    Reason: The AI requires a sufficiently detailed description to generate a meaningful project. If your input in the text field is too short, this message will appear, prompting you to add more detail.

  • Error: "Error processing prompt: Project writing agent failed or was cancelled" or "Error processing prompt: Agent returned error"

    Reason: This indicates an issue with the AI generation process itself. The AI might have encountered an internal problem, or the process was interrupted. Try again with a similar or refined prompt.

Generate Empty Project Errors

  • Error: "Please enter a project name"

    Reason: You must provide a name for your new empty project before it can be created. The project name text field cannot be left blank.