Nexus – Guía de Primer Acceso

Esta guía describe el proceso de solicitud de acceso, los niveles de permisos disponibles y la experiencia inicial dentro de Rocketbot Nexus.

1. Requisitos Previos y Licenciamiento

Para acceder a Nexus, es necesario contar con la Licencia Suite Completa de Rocketbot.

Si deseas solicitar un entorno de prueba para evaluar el producto:

  1. Ponte en contacto con el equipo de Soporte de Rocketbot.
  2. Solicita la activación del Modo Prueba / Trial para la herramienta Nexus en tu cuenta.

2. Tipos de Permiso y Niveles de Acceso

El comportamiento de la plataforma variará dependiendo del rol o permiso asignado a tu usuario por el administrador de Rocketbot:

A. Usuario sin Permiso “Maker” (Sin proyectos asignados/Proyecto compartido)

Si es la primera vez que ingresas a Nexus y no cuentas con el rol de Maker, no tendrás permisos para crear nuevos proyectos ni administrarlos.

  • Pantalla de inicio: Al ingresar, la interfaz mostrará el mensaje:“No applications have been shared with you yet. You’ll see apps here when someone invites you.”

  • Proyectos Compartidos: Si un usuario con rol Maker te comparte una aplicación vía correo electrónico, podrás acceder únicamente a la interfaz en modo ejecución o lectura (vista previa/operativa). No podrás editar, alterar ni acceder a la lógica del diseñador de la aplicación.

B. Usuario con Permiso “Maker” (Desarrollador / Administrador)

Una vez que el administrador de Rocketbot otorga los permisos de Maker, se habilita el panel completo de gestión de aplicaciones.

  • Panel Principal (My Applications): Se habilitará la barra de información de tu entidad (Plan asignado, límite de aplicaciones, usuarios e interfaces permitidos) y el botón + New Application.
  • Gestión y Creación: Desde este panel podrás crear nuevos proyectos desde cero, diseñar vistas, construir interfaces avanzadas y administrar el ciclo de vida de tus aplicaciones.

3. Estados de la Interfaz

Estado del Usuario Vista en Pantalla Capacidades
Sin Permisos / Sin Proyectos Mensaje No applications shared Esperar invitación o asignación de rol Maker por Soporte.
Invitado a Aplicación Dashboard de ejecución Interactuar con la vista desarrollada sin permisos de edición.
Perfil Maker Dashboard con botón + New Application Crear, editar, publicar y gestionar aplicaciones completas.


Nexus – Dashboard

Requisito previo: Para acceder a la interfaz de desarrollador del Dashboard, es indispensable contar previamente con el Modo Maker activado.

1. Menú de Usuario y Configuración

En la esquina superior derecha de la interfaz se encuentra desplegado el Menú de Usuario, al cual se accede haciendo clic sobre el correo electrónico asociado a la cuenta.

Opciones del Menú:

  • Información de Cuenta: Muestra el correo electrónico del perfil actual.
  • Rol / Permiso: Muestra la insignia del nivel de acceso actual (por ejemplo, MAKER).
  • Dashboard: Enlace directo para regresar a la vista principal de gestión de aplicaciones.
  • MCP Keys: Sección destinada a la gestión de claves de integración y conectores.
  • Logout: Opción para cerrar la sesión activa de forma segura.

2. Barra Superior Informativa y Preferencias de Tema

En la parte superior de la pantalla principal se ubican los indicadores generales de la entidad y las herramientas de personalización visual:

  • Cambio de Tema (Dark / Light): Ubicado en la esquina superior derecha (icono de sol/luna), permite alternar entre el modo oscuro y el modo claro según la preferencia del usuario.
  • Barra de Métricas del Plan:

    • Entity: Nombre de la entidad u organización activa.
    • Plan: Tipo de suscripción (ej. Enterprise).
    • Apps: Cantidad de aplicaciones creadas respecto al total permitido.
    • Limits: Límites configurados de usuarios por aplicación y pantallas por aplicación.
    • Expires: Fecha de vencimiento de la suscripción o plan actual.

3. Gestión de Aplicaciones Propias (My Applications)

En este panel principal se listan todas las aplicaciones creadas por el usuario donde posee permisos de edición y administración.

Herramientas de Organización y Búsqueda:

  • Modo de Vista: Permite alternar entre Vista de Cuadrícula (Grid) y Vista de Lista (List) según la comodidad visual.
  • Barra de Búsqueda: Filtro por texto para localizar aplicaciones rápidamente por su nombre o descripción.
  • Filtro de Estado (All statuses): Menú desplegable para segmentar proyectos según su estado:

    • Draft (Borradores)
    • Published (Publicados)
    • All statuses (Todos los estados)

Tarjeta de Aplicación:

Cada aplicación creada muestra la siguiente información y acciones:

  • Icono identificativo y título.
  • Estado actual (ej. Draft o Published).
  • Descripción de la aplicación.
  • Antigüedad / Fecha de creación.
  • Botones de Acción:

    • ✏️ Editar: Permite ingresar al entorno de desarrollo e iteración de la app.
    • 🗑️ Borrar: Elimina la aplicación seleccionada.

4. Proyectos Compartidos (Shared With Me)

En la sección inferior se muestran aquellos proyectos a los cuales el usuario ha sido invitado por otros creadores o entidades (ejemplo: Municipalidad Virtual).

  • Nivel de Permisos: En estas aplicaciones no se cuentan con permisos de modificación.
  • Modo Lectura / Ejecución: El usuario únicamente dispone de la vista de uso de la aplicación, sin opción de editar su estructura, diseño o lógica interna.

5. Creación de una Nueva Aplicación

Para iniciar un nuevo proyecto, se debe seleccionar el botón + New Application ubicado en el panel principal. Esto desplegará el formulario lateral de configuración inicial.

Campos de Configuración:

Campo Descripción
Name * Nombre de la aplicación (campo obligatorio).
Description Resumen o propósito general del proyecto.
Icon Selección de un icono predeterminado desde la galería integrada.
Custom emoji or icon URL Permite ingresar un emoji personalizado o pegar el enlace de un icono externo (https://...).
Card Background / Custom color Paleta de colores predefinidos o selector de color personalizado para la tarjeta en el Dashboard.
Preview Muestra en tiempo real cómo se visualizará la tarjeta de la aplicación.
Published Casilla de verificación: Si se deja desmarcada, la aplicación se guardará como Draft. Al marcarla, pasa a estado Publicado, permitiendo que los usuarios autorizados tengan acceso a ella.

Al finalizar la configuración, se presiona el botón Create Application.

Nota: Una vez creada la aplicación, se redirigirá automáticamente a un nuevo menú de desarrollo interactivo con las herramientas avanzadas para diseñar, construir y modificar los componentes de la app.



Nexus: Edición de Aplicación — App Overview

La sección App Overview es el panel de configuración general para una aplicación dentro de Nexus. Desde esta vista se gestionan las pantallas, la interfaz (encabezados, pies de página, temas), la asignación de usuarios, las claves de API, las variables globales, los tokens de Gateway y los registros de actividad.

1. Cabecera e Identificador de App

En la parte superior de la interfaz de edición se muestran los datos de identificación de la aplicación:

  • Nombre de la Aplicación: Se visualiza con un icono de lápiz a su lado para modificar el nombre del proyecto.
  • ID: Muestra el identificador único de la aplicación junto a un botón para copiarlo al portapapeles.

2. Pantallas (Screens)

Esta sección está destinada a la gestión y creación de las vistas de la aplicación.

🔗 Nota sobre la edición de Pantallas: La configuración, diseño y maquetación detallada de las pantallas cuenta con su propia documentación dedicada debido a su complejidad. Puedes acceder a ella a través del siguiente enlace: [Guía detallada de edición de Screens].

Opciones disponibles en el panel:

  • + New Screen: Botón para crear una nueva pantalla.
  • Pantallas Eliminadas (Deleted screens): Muestra el listado de pantallas que han sido borradas, permitiendo recuperarlas mediante el botón Restore.

3. Configuración del Encabezado (Header Configuration)

Permite definir los elementos visuales de la barra superior en la aplicación:

  • Logo URL: Campo para ingresar el enlace de la imagen del logotipo.
  • Header Title: Campo para definir el título visible en el encabezado.
  • Background Color / Text Color: Controles para elegir el color del fondo y del texto mediante código hexadecimal o selector visual.
  • Preview: Vista previa interactiva de la barra según los colores y el título ingresados.
  • + Add Menu Item: Botón para añadir elementos o secciones de menú al encabezado. Al hacer clic en él, se despliega un formulario para configurar el elemento con las siguientes opciones:

    • Label: Campo de texto para ingresar el nombre visible del item del menú.
    • Icon (optional): Permite asignar un ícono o emoji para acompañar al texto del enlace.
    • Link Type: Selección mediante botón de opción para definir el tipo de destino:

      • Screen: Redirige a una pantalla interna de la aplicación. Habilita el menú desplegable Select Screen (-- Select a screen --) para seleccionar la pantalla deseada.
      • Custom URL: Permite ingresar un enlace o dirección web externa.

    • Botón de eliminación (X rojo): Permite remover el item de menú creado.

  • Show User Profile in Header: Casilla de verificación para activar o desactivar la visualización del perfil de usuario en la barra superior.
  • Botones de acción:

    • Reset: Para restaurar los valores anteriores.
    • Save Configuration: Para guardar los cambios realizados.

4. Configuración del Pie de Página (Footer Configuration)

Administra la barra inferior de la aplicación:

  • Enable Footer: Casilla de verificación para habilitar o deshabilitar la presencia del pie de página.
  • Background Color / Text Color: Ajuste de color del fondo y texto del footer.
  • Height (px): Campo numérico para definir la altura en píxeles del pie de página.
  • HTML Content: Área de texto que permite ingresar código HTML personalizado (como etiquetas <div>, estilos o texto).
  • Preview: Muestra en pantalla el resultado final del código HTML y colores seleccionados.
  • Botones de acción: Reset y Save Configuration.

5. Configuración de Tema (Theme Configuration)

Establece las preferencias de apariencia visual de la app:

  • Default Theme for App: Selector desplegable para definir el tema predeterminado (Light) que se aplicará al abrir la app cuando no haya preferencias guardadas en el navegador del usuario.
  • Show theme switch button in runtime app: Casilla de verificación que, al estar activa, muestra el botón para que los usuarios alternen el tema visual durante la ejecución de la app.
  • Botones de acción: Reset y Save Configuration.

6. Usuarios de la Aplicación (Users)

Sección App Users destinada a invitar y asignar roles a otros usuarios mediante correo electrónico.

Invitar usuarios:

  • Email: Campo de texto (user@example.com) para colocar la dirección del invitado.
  • Role: Desplegable con tres niveles de acceso:

    • Viewer: Puede ver la aplicación publicada y sus datos.
    • Maker: Puede editar el contenido de la app (queries, llamadas a API, funciones).
    • Admin: Puede gestionar usuarios además de poseer todas las capacidades de un Maker.

  • + Invite: Botón para enviar la invitación al usuario.

7. Claves de API (API Keys)

Sección para generar llaves de acceso programático a los datos de la aplicación a través de la API externa.

Generación de llaves:

  • Key Name: Campo de texto para nombrar la clave (ej. Production Backend, Mobile App…).
  • Expiration: Selector desplegable con opciones de caducidad: 30 días, 60 días, 90 días o Sin expiración.
  • Generate: Botón para crear la API Key.

Guía de uso en interfaz (How To Use):

  • Autenticación: Requiere incluir la clave en el encabezado X-API-Key de la petición HTTP.
  • Endpoints disponibles (Available endpoints):

    • Tablas (TABLES):

      • GET /api/v1/external/tables — Listar tablas (List tables).
      • GET /api/v1/external/tables/:id — Obtener tabla (Get table).
      • POST /api/v1/external/tables — Crear tabla (Create table).
      • PUT /api/v1/external/tables/:id — Actualizar tabla (Update table).
      • DELETE /api/v1/external/tables/:id — Eliminar tabla (Delete table).

    • Filas (ROWS):

      • GET /api/v1/external/tables/:id/rows — Listar filas con opciones de límite y desplazamiento (List rows (limit, offset)).
      • POST /api/v1/external/tables/:id/rows — Insertar fila (Insert row).
      • PUT /api/v1/external/rows/:id — Actualizar fila (Update row).
      • DELETE /api/v1/external/rows/:id — Eliminar fila (Delete row).
      • DELETE /api/v1/external/tables/:id/rows — Borrar todas las filas (Erase all rows).
      • PUT /api/v1/external/tables/:id/rows/:rowId/cells/:col — Actualizar celda específica (Update cell).

    • Consultas (QUERIES):

      • GET /api/v1/external/queries — Listar consultas (List queries).
      • POST /api/v1/external/queries/:id/execute — Ejecutar consulta (Execute query).

8. Variables de la Aplicación (Variables)

Permite definir variables globales (App Variables) como llaves de API o constantes de configuración para usarlas en queries, llamadas API y funciones JS.

Creación de variables (+ / New Variable):

  • Key: Nombre de la variable (acepta letras, números y guiones bajos; no se puede editar una vez creada).
  • Value: Valor asignado a la variable.
  • Secret: Casilla opcional para enmascarar el valor en la interfaz gráfica y excluirlo del frontend (disponible únicamente del lado del servidor).
  • Botones: Create y Cancel.

Uso dentro de la plataforma (How To Use):

  • En Queries (filtro de valor): $var.MY_API_KEY o {{var.MY_API_KEY}}.
  • En API Calls (URL, headers, body): {{var.MY_API_KEY}} o $var.MY_API_KEY.
  • En JS Functions: const key = $var.MY_API_KEY;.

9. Pasarela (Gateway)

Sección Gateway Tokens encargada de administrar los tokens para conectar el agente rbnx-gateway con bases de datos locales.

Creación y gestión de Tokens:

  • + New Token: Abre la opción para asignar un Name (ej. Local MySQL Server) y presionar Create.
  • Token generado: Genera una cadena que debe copiarse en el momento (Copy), ya que no se vuelve a mostrar.
  • Archivos auxiliares: Incluye enlace de descarga para config.yaml y botón con icono de descarga para el agente ejecutable.
  • Acciones en lista de tokens: Cada token creado muestra su estado (Active) y cuenta con opciones para deshabilitarlo o eliminarlo (icono de papelera).

Pasos indicados en la interfaz (How to use the Gateway?):

  1. Crear un token y descargar el archivo config.yaml.
  2. Descargar el agente rbnx-gateway para la plataforma correspondiente.
  3. Editar config.yaml con los detalles de la base de datos local.
  4. Ejecutar el comando ./rbnx-gateway --config config.yaml.
  5. En la app, crear un DataSource de tipo Gateway On-Premises y seleccionar dicho token.

10. Registros de Actividad (Activity Logs)

Muestra la lista de acciones realizadas por usuarios con rol Maker y Viewer en la aplicación.

  • Listado de datos en tabla:

    • USER: Dirección de correo del usuario.
    • METHOD: Método de la petición (DELETE, POST, etc.).
    • PATH: Ruta del endpoint consultado (ej. /api/v1/gateway/gateway-tokens/...).
    • STATUS: Código de respuesta de la petición (ej. 200, 201).
    • DURATION: Tiempo de respuesta medido en milisegundos (ej. 25ms).
    • DATE: Fecha y hora exacta de la acción.

  • Botón Refresh: Ubicado en la parte superior derecha para actualizar el historial de eventos.