diff --git a/docs/developer-guide/etendo-copilot/available-tools/task-creator-tool.md b/docs/developer-guide/etendo-copilot/available-tools/task-creator-tool.md index 63c203e484..b860169602 100644 --- a/docs/developer-guide/etendo-copilot/available-tools/task-creator-tool.md +++ b/docs/developer-guide/etendo-copilot/available-tools/task-creator-tool.md @@ -33,7 +33,7 @@ It is especially useful for team collaboration, project onboarding, data entry w ## Setup -The tool doesn’t require specific environment variables from the user. However, it depends on the internal Etendo configuration for token and host retrieval, using the `ETENDO_TOKEN` and `ETENDO_HOST` values internally. These values are handled securely and **are never exposed to the model**. +The tool does not require specific environment variables from the user. However, it depends on the internal Etendo configuration for token and host retrieval, using the `ETENDO_TOKEN` and `etendo.host` values internally. These values are handled securely and **are never exposed to the model**. ### Supported File Formats diff --git a/docs/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md b/docs/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md index b29bf5cdec..6c08a84656 100644 --- a/docs/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md +++ b/docs/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md @@ -40,9 +40,9 @@ A convenient option is **LiteLLM Proxy**, which simplifies handling different LL 2. **Create the `.env` file**: Store provider API keys securely in this file. Replace placeholders with your real keys: ```bash - OPENAI_API_KEY=sk-proj-XXXXXXX - ANTHROPIC_API_KEY=sk-ant-XXXXXXXXXX - GOOGLE_API_KEY= + openai.api.key=sk-proj-XXXXXXX + anthropic.api.key=sk-ant-XXXXXXXXXX + google.api.key= ``` 3. **Run the proxy with Docker**: Place `litellm_config.yaml` and `.env` in the same directory and run: diff --git a/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md b/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md index d43369cd6d..21b7c16a1d 100644 --- a/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md +++ b/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md @@ -33,8 +33,8 @@ Some of the main fields to be completed are: - **Model**: Dropdown with the models available, such as OpenAI, Anthropic, etc. Go to section [Which model should I choose?](#which-model-should-i-choose) for more information. !!!info - The **Prompt** field can have the following dynamic variables: `@context.url@`, `@ETENDO_HOST@`, `@ETENDO_HOST_DOCKER@` and `@source.path@` - These variables will be replaced with the values defined in the properties. + The **Prompt** field can have the following dynamic variables: `@context.url@`, `@etendo.host@`, `@etendo.host.docker@` and `@source.path@`. + These variables are replaced with the values defined in the `gradle.properties` file. !!!note For more information on what each field is used for, visit the [Setup and Usage - Agents](../../../user-guide/etendo-copilot/setup-and-usage.md#header) guide. diff --git a/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md b/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md index 2127e31686..1cfe21c6e2 100644 --- a/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md +++ b/docs/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md @@ -123,7 +123,7 @@ In this example, you will create a tool that performs a **ping** to a specified !!! note "Environment variables" Copilot automatically reads the `gradle.properties` file of **Etendo Classic** and exposes these as environment variables (dots replaced with underscores). For example: - - `COPILOT_PORT` → `COPILOT_PORT` + - `copilot.port` → `copilot_port` - `bbdd.sid` → `bbdd_sid` You can access these environment variables in your tools. @@ -268,7 +268,7 @@ The above tool leverages utilities provided by Copilot Core: - `get_etendo_token()`: This function returns the authentication token for Etendo Classic, allowing the tool to operate within the user's session. Copilot, acting as a "proxy," manages these sessions. -- `get_etendo_host()`: This function returns the URL of the Etendo Classic instance, which is required to trigger the WebHook. This host URL is configured as `ETENDO_HOST` in the `gradle.properties` configuration file. +- `get_etendo_host()`: This function returns the URL of the Etendo Classic instance, which is required to trigger the WebHook. This host URL is configured as `etendo.host` in the `gradle.properties` configuration file. - `call_webhook(url:String, webhook_name:String, access_token:String, body_params:Dict)`: This function triggers the WebHook, passing the Etendo Classic URL, the WebHook name, the authentication token, and the parameters needed by the WebHook. diff --git a/docs/developer-guide/etendo-copilot/installation.md b/docs/developer-guide/etendo-copilot/installation.md index 58987c3265..b518f6df64 100644 --- a/docs/developer-guide/etendo-copilot/installation.md +++ b/docs/developer-guide/etendo-copilot/installation.md @@ -58,11 +58,11 @@ The latest Copilot updates are always developed for the most recent available Et ```groovy title="gradle.properties" docker_com.etendoerp.copilot=true - OPENAI_API_KEY= **** - ETENDO_HOST=http://localhost:8080/etendo - ETENDO_HOST_DOCKER=http://host.docker.internal:8080/etendo - COPILOT_HOST=copilot - COPILOT_PORT=5005 + openai.api.key= **** + etendo.host=http://localhost:8080/etendo + etendo.host.docker=http://host.docker.internal:8080/etendo + copilot.host=copilot + copilot.port=5005 ``` 3. Then, the copilot container needs to be created/recreated: @@ -90,13 +90,13 @@ The latest Copilot updates are always developed for the most recent available Et ```groovy title="gradle.properties" docker_com.etendoerp.copilot=true - OPENAI_API_KEY= **** // If you are using OpenAI - ANTHROPIC_API_KEY= **** // If you are using Anthropic + openai.api.key= **** // If you are using OpenAI + anthropic.api.key= **** // If you are using Anthropic DEEPSEEK_API_KEY= **** // If you are using DeepSeek - GOOGLE_API_KEY= **** // If you are using Gemini + google.api.key= **** // If you are using Gemini ``` -2. The `gradle.properties` variables `ETENDO_HOST`,`ETENDO_HOST_DOCKER`, `COPILOT_HOST`, and `COPILOT_PORT` are used to configure the connection between **Copilot** service and **Etendo**. +2. The `gradle.properties` variables `etendo.host`, `etendo.host.docker`, `copilot.host`, and `copilot.port` are used to configure the connection between **Copilot** service and **Etendo**. Etendo Copilot provides a **Gradle task** to automatically retrieve these variables based on your Etendo instance configuration. To do this, execute the following command in the terminal: @@ -114,13 +114,13 @@ The latest Copilot updates are always developed for the most recent available Et ```groovy title="gradle.properties" docker_com.etendoerp.copilot=true - OPENAI_API_KEY= **** // If you are using OpenAI - ANTHROPIC_API_KEY= **** // If you are using Anthropic + openai.api.key= **** // If you are using OpenAI + anthropic.api.key= **** // If you are using Anthropic DEEPSEEK_API_KEY= **** // If you are using DeepSeek - ETENDO_HOST=http://localhost:8080/etendo - ETENDO_HOST_DOCKER=http://host.docker.internal:8080/etendo - COPILOT_HOST=copilot - COPILOT_PORT=5005 + etendo.host=http://localhost:8080/etendo + etendo.host.docker=http://host.docker.internal:8080/etendo + copilot.host=copilot + copilot.port=5005 ``` 4. Once the [Copilot Extensions Bundle](https://marketplace.etendo.cloud/#/product-details?module=82C5DA1B57884611ABA8F025619D4C05){target="_blank"} dependency was added and the variables configured, in the terminal execute the following command to apply the changes: @@ -147,26 +147,26 @@ The latest Copilot updates are always developed for the most recent available Et All available configuration variables are listed below and can be configured manually. -| **Environment Variable** | **Default** | **Required** | **Info** | +| **Variable** | **Default** | **Required** | **Info** | | -------------------------------- | ------------------ | ----------------------| ----------------------------------------------------------------------------------------------------------------- | | `docker_com.etendoerp.copilot` | `true` | ✅ (Required) | Enables Etendo Copilot Docker container. | -| `OPENAI_API_KEY` | `none` | ✅ If using OpenAI | API key for [OpenAI](https://platform.openai.com/account/api-keys){target="_blank"}. Contact Etendo or use your own. | -| `GOOGLE_API_KEY` | `none` | ✅ If using Gemini | API key for [Gemini](https://aistudio.google.com/app/api-keys){target="_blank"}. Only needed if using Gemini models. | -| `ANTHROPIC_API_KEY` | `none` | ✅ If using Anthropic | API key for [Anthropic](https://docs.anthropic.com/en/api/getting-started){target="_blank"}. Only needed if using Anthropic models.| +| `openai.api.key` | `none` | ✅ If using OpenAI | API key for [OpenAI](https://platform.openai.com/account/api-keys){target="_blank"}. Contact Etendo or use your own. | +| `google.api.key` | `none` | ✅ If using Gemini | API key for [Gemini](https://aistudio.google.com/app/api-keys){target="_blank"}. Only needed if using Gemini models. | +| `anthropic.api.key` | `none` | ✅ If using Anthropic | API key for [Anthropic](https://docs.anthropic.com/en/api/getting-started){target="_blank"}. Only needed if using Anthropic models.| | `DEEPSEEK_API_KEY` | `none` | ✅ If using DeepSeek | API key for [DeepSeek](https://deepseek.ai/){target="_blank"}. Only needed if using DeepSeek models. | -| `ETENDO_HOST` | `none` | ✅ (Required) | URL where Copilot sends requests to communicate with the Etendo system. | -| `ETENDO_HOST_DOCKER` | `none` | ✅ (Required) | Used when Copilot runs in Docker and Etendo is not accessible from a domain. | -| `COPILOT_HOST` | `none` | ✅ (Required) | Host for Copilot service. | -| `COPILOT_PORT` | `5005` | ✅ (Required) | Port used by Copilot service. | -| `COPILOT_DEBUG` | `false` | ❌ (Optional) | Enables verbose Copilot logs in the console. | +| `etendo.host` | `none` | ✅ (Required) | URL where Copilot sends requests to communicate with the Etendo system. | +| `etendo.host.docker` | `none` | ✅ (Required) | Used when Copilot runs in Docker and Etendo is not accessible from a domain. | +| `copilot.host` | `none` | ✅ (Required) | Host for Copilot service. | +| `copilot.port` | `5005` | ✅ (Required) | Port used by Copilot service. | +| `copilot.debug` | `false` | ❌ (Optional) | Enables verbose Copilot logs in the console. | | `COPILOT_MAX_ITERATIONS` | `100` | ❌ (Optional) | Max number of agent interaction steps. | | `COPILOT_EXECUTION_TIMEOUT` | `0` | ❌ (Optional) | Timeout in seconds for agent execution (`0` = unlimited). | -| `COPILOT_STREAM_DEBUG` | `false` | ❌ (Optional) | Enables real-time response log in Copilot pop-up. | +| `copilot.stream.debug` | `false` | ❌ (Optional) | Enables real-time response log in Copilot pop-up. | | `CONFIGURED_TOOLS_FILENAME` | `tools_config.json`| ❌ (Optional) | File that defines which tools are enabled. | | `DEPENDENCIES_TOOLS_FILENAME` | `tools_deps.toml` | ❌ (Optional) | File that defines dependencies between tools. | | `COPILOT_PULL_IMAGE` | `true` | ❌ (Optional) | If true, pulls Docker image from Docker Hub; if false, uses local image. | | `COPILOT_IMAGE_TAG` | `master` | ❌ (Optional) | Docker image tag to use. | -| `COPILOT_PORT_DEBUG` | `5100` | ❌ (Optional) | Port for debugging Copilot (if enabled). | +| `copilot.port.debug` | `5100` | ❌ (Optional) | Port for debugging Copilot (if enabled). | ### Copilot Service Container Management diff --git a/docs/es/developer-guide/etendo-copilot/available-tools/task-creator-tool.md b/docs/es/developer-guide/etendo-copilot/available-tools/task-creator-tool.md index 9fcbcfe15d..e09510ee83 100644 --- a/docs/es/developer-guide/etendo-copilot/available-tools/task-creator-tool.md +++ b/docs/es/developer-guide/etendo-copilot/available-tools/task-creator-tool.md @@ -33,7 +33,7 @@ Es especialmente útil para la colaboración en equipo, la incorporación a proy ## Configuración -La herramienta no requiere variables de entorno específicas por parte del usuario. Sin embargo, depende de la configuración interna de Etendo para la obtención del token y del host, utilizando internamente los valores `ETENDO_TOKEN` y `ETENDO_HOST`. Estos valores se gestionan de forma segura y **nunca se exponen al modelo**. +La herramienta no requiere variables de entorno específicas por parte del usuario. Sin embargo, depende de la configuración interna de Etendo para la obtención del token y del host, utilizando internamente los valores `ETENDO_TOKEN` y `etendo.host`. Estos valores se gestionan de forma segura y **nunca se exponen al modelo**. ### Formatos de archivo compatibles diff --git a/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md b/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md index b7de87745a..9545c64966 100644 --- a/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md +++ b/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-configure-etendo-copilot-proxy.md @@ -39,9 +39,9 @@ Una opción conveniente es **LiteLLM Proxy**, que simplifica la gestión de dist 2. **Crear el archivo `.env`**: Almacene de forma segura en este archivo las claves API del proveedor. Sustituya los placeholders por sus claves reales: ```bash - OPENAI_API_KEY=sk-proj-XXXXXXX - ANTHROPIC_API_KEY=sk-ant-XXXXXXXXXX - GOOGLE_API_KEY= + openai.api.key=sk-proj-XXXXXXX + anthropic.api.key=sk-ant-XXXXXXXXXX + google.api.key= ``` 3. **Ejecutar el proxy con Docker**: Coloque `litellm_config.yaml` y `.env` en el mismo directorio y ejecute: diff --git a/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md b/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md index f67e80d227..9051e14725 100644 --- a/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md +++ b/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-an-agent.md @@ -32,8 +32,8 @@ Algunos de los campos principales que deben completarse son: - **Model**: desplegable con los modelos disponibles, como OpenAI, Anthropic, etc. Vaya a la sección [¿Qué modelo debería elegir?](#qué-modelo-debería-elegir) para más información. !!!info - El campo **Prompt** puede tener las siguientes variables dinámicas: `@context.url@`, `@ETENDO_HOST@`, `@ETENDO_HOST_DOCKER@` y `@source.path@` - Estas variables se sustituirán por los valores definidos en las propiedades. + El campo **Prompt** puede tener las siguientes variables dinámicas: `@context.url@`, `@etendo.host@`, `@etendo.host.docker@` y `@source.path@`. + Estas variables se sustituyen por los valores definidos en el archivo `gradle.properties`. !!!note Para más información sobre para qué se utiliza cada campo, visite la guía [Configuración y uso - Agentes](../../../user-guide/etendo-copilot/setup-and-usage.md#header). diff --git a/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md b/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md index ff942b6160..6704007c88 100644 --- a/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md +++ b/docs/es/developer-guide/etendo-copilot/how-to-guides/how-to-create-copilot-tools.md @@ -123,7 +123,7 @@ En este ejemplo, creará una herramienta que realiza un **ping** a un host espec !!! note "Variables de entorno" Copilot lee automáticamente el archivo `gradle.properties` de **Etendo Classic** y las expone como variables de entorno (puntos reemplazados por guiones bajos). Por ejemplo: - - `COPILOT_PORT` → `COPILOT_PORT` + - `copilot.port` → `copilot_port` - `bbdd.sid` → `bbdd_sid` Puede acceder a estas variables de entorno en sus herramientas. @@ -268,7 +268,7 @@ La herramienta anterior aprovecha utilidades proporcionadas por Copilot Core: - `get_etendo_token()`: esta función devuelve el token de autenticación para Etendo Classic, permitiendo que la herramienta opere dentro de la sesión del usuario. Copilot, actuando como un "proxy", gestiona estas sesiones. -- `get_etendo_host()`: esta función devuelve la URL de la instancia de Etendo Classic, que es necesaria para disparar el WebHook. Esta URL de host se configura como `ETENDO_HOST` en el archivo de configuración `gradle.properties`. +- `get_etendo_host()`: esta función devuelve la URL de la instancia de Etendo Classic, que es necesaria para disparar el WebHook. Esta URL de host se configura como `etendo.host` en el archivo de configuración `gradle.properties`. - `call_webhook(url:String, webhook_name:String, access_token:String, body_params:Dict)`: esta función dispara el WebHook, pasando la URL de Etendo Classic, el nombre del WebHook, el token de autenticación y los parámetros necesarios por el WebHook. diff --git a/docs/es/developer-guide/etendo-copilot/installation.md b/docs/es/developer-guide/etendo-copilot/installation.md index bd8466a777..6231e5ade6 100644 --- a/docs/es/developer-guide/etendo-copilot/installation.md +++ b/docs/es/developer-guide/etendo-copilot/installation.md @@ -57,11 +57,11 @@ Las últimas actualizaciones de Copilot siempre se desarrollan para la versión ```groovy title="gradle.properties" docker_com.etendoerp.copilot=true - OPENAI_API_KEY= **** - ETENDO_HOST=http://localhost:8080/etendo - ETENDO_HOST_DOCKER=http://host.docker.internal:8080/etendo - COPILOT_HOST=copilot - COPILOT_PORT=5005 + openai.api.key= **** + etendo.host=http://localhost:8080/etendo + etendo.host.docker=http://host.docker.internal:8080/etendo + copilot.host=copilot + copilot.port=5005 ``` 3. A continuación, debe crearse/recrearse el contenedor de Copilot: @@ -89,13 +89,13 @@ Las últimas actualizaciones de Copilot siempre se desarrollan para la versión ```groovy title="gradle.properties" docker_com.etendoerp.copilot=true - OPENAI_API_KEY= **** // If you are using OpenAI - ANTHROPIC_API_KEY= **** // If you are using Anthropic + openai.api.key= **** // If you are using OpenAI + anthropic.api.key= **** // If you are using Anthropic DEEPSEEK_API_KEY= **** // If you are using DeepSeek - GOOGLE_API_KEY= **** // If you are using Gemini + google.api.key= **** // If you are using Gemini ``` -2. Las variables de `gradle.properties` `ETENDO_HOST`, `ETENDO_HOST_DOCKER`, `COPILOT_HOST` y `COPILOT_PORT` se utilizan para configurar la conexión entre el servicio **Copilot** y **Etendo**. +2. Las variables de `gradle.properties` `etendo.host`, `etendo.host.docker`, `copilot.host` y `copilot.port` se utilizan para configurar la conexión entre el servicio **Copilot** y **Etendo**. Etendo Copilot proporciona una **tarea de Gradle** para recuperar automáticamente estas variables en función de la configuración de su instancia de Etendo. Para ello, ejecute el siguiente comando en el terminal: @@ -113,13 +113,13 @@ Las últimas actualizaciones de Copilot siempre se desarrollan para la versión ```groovy title="gradle.properties" docker_com.etendoerp.copilot=true - OPENAI_API_KEY= **** // If you are using OpenAI - ANTHROPIC_API_KEY= **** // If you are using Anthropic + openai.api.key= **** // If you are using OpenAI + anthropic.api.key= **** // If you are using Anthropic DEEPSEEK_API_KEY= **** // If you are using DeepSeek - ETENDO_HOST=http://localhost:8080/etendo - ETENDO_HOST_DOCKER=http://host.docker.internal:8080/etendo - COPILOT_HOST=copilot - COPILOT_PORT=5005 + etendo.host=http://localhost:8080/etendo + etendo.host.docker=http://host.docker.internal:8080/etendo + copilot.host=copilot + copilot.port=5005 ``` 4. Una vez añadida la dependencia [Copilot Extensions Bundle](https://marketplace.etendo.cloud/#/product-details?module=82C5DA1B57884611ABA8F025619D4C05){target="_blank"} y configuradas las variables, ejecute en el terminal el siguiente comando para aplicar los cambios: @@ -146,26 +146,26 @@ Las últimas actualizaciones de Copilot siempre se desarrollan para la versión A continuación se enumeran todas las variables de configuración disponibles, que pueden configurarse manualmente. -| **Variable de entorno** | **Predeterminado** | **Obligatorio** | **Información** | +| **Variable** | **Predeterminado** | **Obligatorio** | **Información** | | -------------------------------- | ------------------ | ---------------------- | ----------------------------------------------------------------------------------------------------------------- | | `docker_com.etendoerp.copilot` | `true` | ✅ (Obligatorio) | Habilita el contenedor Docker de Etendo Copilot. | -| `OPENAI_API_KEY` | `none` | ✅ Si usa OpenAI | Clave API para [OpenAI](https://platform.openai.com/account/api-keys){target="_blank"}. Contacte con Etendo o use la suya propia. | -| `GOOGLE_API_KEY` | `none` | ✅ Si usa Gemini | Clave API para [Gemini](https://aistudio.google.com/app/api-keys){target="_blank"}. Solo necesaria si usa modelos Gemini. | -| `ANTHROPIC_API_KEY` | `none` | ✅ Si usa Anthropic | Clave API para [Anthropic](https://docs.anthropic.com/en/api/getting-started){target="_blank"}. Solo necesaria si usa modelos Anthropic. | +| `openai.api.key` | `none` | ✅ Si usa OpenAI | Clave API para [OpenAI](https://platform.openai.com/account/api-keys){target="_blank"}. Contacte con Etendo o use la suya propia. | +| `google.api.key` | `none` | ✅ Si usa Gemini | Clave API para [Gemini](https://aistudio.google.com/app/api-keys){target="_blank"}. Solo necesaria si usa modelos Gemini. | +| `anthropic.api.key` | `none` | ✅ Si usa Anthropic | Clave API para [Anthropic](https://docs.anthropic.com/en/api/getting-started){target="_blank"}. Solo necesaria si usa modelos Anthropic. | | `DEEPSEEK_API_KEY` | `none` | ✅ Si usa DeepSeek | Clave API para [DeepSeek](https://deepseek.ai/){target="_blank"}. Solo necesaria si usa modelos DeepSeek. | -| `ETENDO_HOST` | `none` | ✅ (Obligatorio) | URL a la que Copilot envía solicitudes para comunicarse con el sistema Etendo. | -| `ETENDO_HOST_DOCKER` | `none` | ✅ (Obligatorio) | Se utiliza cuando Copilot se ejecuta en Docker y Etendo no es accesible desde un dominio. | -| `COPILOT_HOST` | `none` | ✅ (Obligatorio) | Host del servicio Copilot. | -| `COPILOT_PORT` | `5005` | ✅ (Obligatorio) | Puerto utilizado por el servicio Copilot. | -| `COPILOT_DEBUG` | `false` | ❌ (Opcional) | Habilita logs detallados de Copilot en la consola. | +| `etendo.host` | `none` | ✅ (Obligatorio) | URL a la que Copilot envía solicitudes para comunicarse con el sistema Etendo. | +| `etendo.host.docker` | `none` | ✅ (Obligatorio) | Se utiliza cuando Copilot se ejecuta en Docker y Etendo no es accesible desde un dominio. | +| `copilot.host` | `none` | ✅ (Obligatorio) | Host del servicio Copilot. | +| `copilot.port` | `5005` | ✅ (Obligatorio) | Puerto utilizado por el servicio Copilot. | +| `copilot.debug` | `false` | ❌ (Opcional) | Habilita logs detallados de Copilot en la consola. | | `COPILOT_MAX_ITERATIONS` | `100` | ❌ (Opcional) | Número máximo de pasos de interacción del agente. | | `COPILOT_EXECUTION_TIMEOUT` | `0` | ❌ (Opcional) | Tiempo de espera en segundos para la ejecución del agente (`0` = ilimitado). | -| `COPILOT_STREAM_DEBUG` | `false` | ❌ (Opcional) | Habilita el log de respuesta en tiempo real en el pop-up de Copilot. | +| `copilot.stream.debug` | `false` | ❌ (Opcional) | Habilita el log de respuesta en tiempo real en el pop-up de Copilot. | | `CONFIGURED_TOOLS_FILENAME` | `tools_config.json`| ❌ (Opcional) | Archivo que define qué herramientas están habilitadas. | | `DEPENDENCIES_TOOLS_FILENAME` | `tools_deps.toml` | ❌ (Opcional) | Archivo que define dependencias entre herramientas. | | `COPILOT_PULL_IMAGE` | `true` | ❌ (Opcional) | Si es true, descarga la imagen Docker desde Docker Hub; si es false, usa la imagen local. | | `COPILOT_IMAGE_TAG` | `master` | ❌ (Opcional) | Tag de la imagen Docker a utilizar. | -| `COPILOT_PORT_DEBUG` | `5100` | ❌ (Opcional) | Puerto para depurar Copilot (si está habilitado). | +| `copilot.port.debug` | `5100` | ❌ (Opcional) | Puerto para depurar Copilot (si está habilitado). | ### Gestión del contenedor del servicio Copilot diff --git a/docs/es/user-guide/etendo-copilot/bundles/sql-expert.md b/docs/es/user-guide/etendo-copilot/bundles/sql-expert.md index b316d1538f..7acbd9f6d7 100644 --- a/docs/es/user-guide/etendo-copilot/bundles/sql-expert.md +++ b/docs/es/user-guide/etendo-copilot/bundles/sql-expert.md @@ -30,10 +30,10 @@ El agente Experto SQL se compone de los siguientes componentes: !!! info Para poder incluir este agente, debe estar instalado el Copilot Extensions Bundle. Para ello, siga las instrucciones del marketplace: [Copilot Extensions Bundle](https://marketplace.etendo.cloud/#/product-details?module=82C5DA1B57884611ABA8F025619D4C05){target="_blank"}. Para más información sobre las versiones disponibles, compatibilidad con el core y nuevas funcionalidades, visite [Copilot Extensions - Notas de la versión](../../../whats-new/release-notes/etendo-copilot/bundles/release-notes.md). -2. Compruebe la variable `ETENDO_HOST` necesaria en el archivo `gradle.properties`. - +2. Compruebe la variable `etendo.host` necesaria en el archivo `gradle.properties`. + ```groovy title="gradle.properties" - ETENDO_HOST=http://localhost:8080/etendo + etendo.host=http://localhost:8080/etendo ``` !!! warning diff --git a/docs/es/user-guide/etendo-copilot/setup-and-usage.md b/docs/es/user-guide/etendo-copilot/setup-and-usage.md index c710d10015..2326566492 100644 --- a/docs/es/user-guide/etendo-copilot/setup-and-usage.md +++ b/docs/es/user-guide/etendo-copilot/setup-and-usage.md @@ -71,11 +71,18 @@ Campos a tener en cuenta: - **Módulo**: módulo en el que se exportarán el agente y todas sus configuraciones. Este campo solo está disponible con el rol `System Administrator`. - **Activo**: casilla para activar o no el agente. -- **SystemApp**: casilla para limitar el uso de determinados agentes únicamente bajo el rol `system administrator` y no disponible para usuarios finales. +- **Alcance del agente**: define el alcance de visibilidad del agente. Opciones disponibles: + + - **Client**: el agente solo está disponible para el cliente en el que fue creado. Este es el valor por defecto. + - **System**: el agente solo está disponible bajo el rol `System Administrator`. + - **Client + System**: el agente está disponible para el cliente y también bajo el rol `System Administrator`. + +- **Sincronizar al inicio**: cuando está habilitado, el agente se sincroniza automáticamente cuando el sistema Etendo se inicia. Esto elimina la necesidad de ejecutar manualmente el proceso `Sincronizar agente` después de cada reinicio, asegurando que el agente esté siempre actualizado. +- **Destacado**: cuando está habilitado, el agente se resalta y aparece primero en el desplegable de agentes del Chat de Copilot. Cuando existen agentes destacados, el desplegable del chat muestra un botón de filtro (⭐) que permite a los usuarios alternar entre ver solo agentes destacados o todos los agentes disponibles. Por defecto, cuando existen agentes destacados, el desplegable muestra solo los destacados. - **Prompt**: instrucciones específicas de los agentes. Estas instrucciones pueden escribirse en inglés o en español. !!!info - El campo **Prompt** puede tener las siguientes variables dinámicas: `@context.url@`, `@ETENDO_HOST@`, `@ETENDO_HOST_DOCKER@` y `@source.path@`. Estas variables se sustituirán por los valores definidos en el archivo `gradle.properties`. + El campo **Prompt** puede tener las siguientes variables dinámicas: `@context.url@`, `@etendo.host@`, `@etendo.host.docker@` y `@source.path@`. Estas variables se sustituyen por los valores definidos en el archivo `gradle.properties`. - **Vista previa del grafo**: en caso de definir una aplicación de tipo **LangGraph**, muestra el árbol de agentes bajo un determinado gestor. diff --git a/docs/user-guide/etendo-copilot/bundles/sql-expert.md b/docs/user-guide/etendo-copilot/bundles/sql-expert.md index 013f9a45b0..fdfef899c7 100644 --- a/docs/user-guide/etendo-copilot/bundles/sql-expert.md +++ b/docs/user-guide/etendo-copilot/bundles/sql-expert.md @@ -32,10 +32,10 @@ The SQL Expert Agent is composed of the following components: To be able to include this agent, the Copilot Extensions Bundle must be installed. To do that, follow the instructions from the marketplace: [Copilot Extensions Bundle](https://marketplace.etendo.cloud/#/product-details?module=82C5DA1B57884611ABA8F025619D4C05){target="_blank"}. For more information about the available versions, core compatibility and new features, visit [Copilot Extensions - Release notes](../../../whats-new/release-notes/etendo-copilot/bundles/release-notes.md). -2. Check the necessary `ETENDO_HOST` variable in the `gradle.properties` file. - +2. Check the necessary `etendo.host` variable in the `gradle.properties` file. + ```groovy title="gradle.properties" - ETENDO_HOST=http://localhost:8080/etendo + etendo.host=http://localhost:8080/etendo ``` !!! warning diff --git a/docs/user-guide/etendo-copilot/setup-and-usage.md b/docs/user-guide/etendo-copilot/setup-and-usage.md index 167f177089..d5facae3f3 100644 --- a/docs/user-guide/etendo-copilot/setup-and-usage.md +++ b/docs/user-guide/etendo-copilot/setup-and-usage.md @@ -73,11 +73,18 @@ Fields to note: - **Module**: Module in which the agent and all its configurations will be exported. This field is only available with the `System Administrator` role. - **Active**: Checkbox to activate or not the agent. -- **SystemApp**: Checkbox to limit the use of certain agents only under the `system administrator` role and not available to end users. +- **Agent Scope**: Defines the visibility scope of the agent. Available options: + + - **Client**: The agent is available only for the client in which it was created. This is the default value. + - **System**: The agent is available only under the `System Administrator` role. + - **Client + System**: The agent is available for the client and also under the `System Administrator` role. + +- **Sync on Startup**: When enabled, the agent is automatically synchronized when the Etendo system starts up. This eliminates the need to manually trigger the `Sync Agent` process after each restart, ensuring the agent is always up to date. +- **Featured**: When enabled, the agent is highlighted and shown first in the Copilot Chat agent dropdown. When there are featured agents, the chat dropdown shows a filter toggle button (⭐) that allows users to switch between viewing only featured agents or all available agents. By default, when featured agents exist, the dropdown shows only the featured ones. - **Prompt**: Specific instructions of the agents. These instructions can be written in English or Spanish. !!!info - The **Prompt** field can have the following dynamic variables: `@context.url@`, `@ETENDO_HOST@`, `@ETENDO_HOST_DOCKER@` and `@source.path@`. These variables will be replaced with the values defined in the `gradle.properties`file. + The **Prompt** field can have the following dynamic variables: `@context.url@`, `@etendo.host@`, `@etendo.host.docker@` and `@source.path@`. These variables are replaced with the values defined in the `gradle.properties` file. - **Graph Preview**: In case of defining an **LangGraph** type app, it shows the tree of agents under a certain manager.