Operaciones de Módulos

Las “Operaciones” son llamadas atómicas a APIs, vinculadas a un módulo, que encapsulan la ejecución de una función previamente configurada. Es decir, las operaciones son las acciones que podrá realizar tu módulo cuando se agreguen posteriormente a un flujo.

Ejemplo: imagina que tenemos un módulo llamado “VentasY” y puede realizar las siguientes operaciones:

Listar todas las ventas del día
Listar los 10 productos más vendidos
Agregar un producto y su respectivo precio

Todos estos ejemplos son configurables a través de las operaciones.

Sin una operación, no es posible utilizar un módulo en tus flujos.

Cómo agregar una operación

Haz clic en “Nueva operación”.

Es necesario completar la información en la sección “Configuraciones” para habilitar la creación de operaciones.

A continuación, se mostrará la pantalla para completar los datos de la nueva operación, dividida en 4 etapas:

A continuación, se detalla paso a paso cada ítem:

Información General

Agrega el nombre y la descripción de la nueva operación.
Luego, haz clic en “Siguiente paso”.

Parámetros

En esta etapa configurarás los parámetros que serán utilizados en el módulo, siempre de acuerdo con el tipo de conectividad (Base de Datos, Email, REST, etc.). Para esto:

Haz clic en “Agregar parámetro”. Aparecerá el siguiente modal:

Campos:

Nombre: elige un nombre que describa mejor la función del parámetro.
Descripción: describe la función del parámetro.
Tipo: selecciona el tipo de dato aceptado por el parámetro:

Texto: cualquier combinación de caracteres alfanuméricos. Ejemplos: "cualquiertexto", "123"
Número: cualquier número. Ejemplos: 123, 321
Booleano: true/false (verdadero/falso)
Objeto: objeto JSON. Ejemplo: { "name": "John" }
Array: array JSON. Ejemplos: [ "A", "B" ], [ "1", "2" ]

Campo obligatorio: al seleccionarlo, el parámetro será obligatorio y siempre deberá enviarse en el JSON de entrada.
Dato sensible: si se selecciona, indica que el valor del parámetro no será publicado si el módulo se comparte.
Ejemplo: agrega un ejemplo acorde al tipo de dato y al tipo de conectividad del módulo (Base de datos, Email, REST, etc.). Ejemplos:
1. Base de datos: utiliza comandos SQL válidos (SELECT, UPDATE, DELETE, etc.).
2. REST: utiliza operaciones GET, POST, PUT, DELETE o PATCH.
Para finalizar, haz clic en “Guardar información”.

Puedes hacer clic en “Nuevo parámetro” para agregar otro ítem, o en “Siguiente paso” para continuar con la configuración de Solicitud (Requisición).

No hay límite en el número de parámetros que se pueden crear, pero se recomienda que la nomenclatura y la descripción sean claras y estructuradas para facilitar su identificación y uso.

Solicitud (Requisición)

En esta pestaña, podrás redactar la solicitud usando los parámetros creados previamente. Para facilitar, las indicaciones están organizadas según el tipo de conectividad. Haz clic en la opción correspondiente:

Base de Datos

En los módulos del tipo Base de Datos, el área de Solicitud (Requisición) contiene el campo "Query" y los parámetros disponibles, que pueden ser arrastrados directamente dentro de este campo.

Si lo prefieres, también puedes agregar otros parámetros manualmente dentro de la consulta.

A continuación, haz clic en "Siguiente paso" (Estructura de salida).

Correo electrónico

En los módulos del tipo Correo electrónico (Email), el área de Solicitud (Requisición) contiene los siguientes campos:

Parámetros disponibles: lista de los parámetros creados previamente.
Destinatario: arrastra el parámetro correspondiente a este campo.
Asunto: arrastra el parámetro correspondiente a este campo.
Cuerpo (Body): además del parámetro creado previamente, este campo requiere un código HTML, como en el siguiente ejemplo:

REST

En los módulos del tipo REST, el área de Solicitud (Requisición) contiene los siguientes campos:

Parámetros disponibles: lista de los parámetros creados previamente.
Método: selecciona el método HTTP que se utilizará en la solicitud. Las opciones disponibles son:
- GET: utilizado para recuperar datos.
- POST: enviar datos o crear nuevos recursos.
- PUT: actualizar recursos de forma completa.
- DELETE: eliminar recursos.
- PATCH: actualizar recursos parcialmente.
URL (no obligatorio): elige el formato de la URL que será utilizada en la solicitud:
- PATH: ruta relativa, usada cuando la URL base ya está definida en otro lugar.
- FULL URL: dirección completa, útil para solicitudes fuera del dominio.
Endpoint: escribe o pega la ruta que será llamada para realizar la solicitud.
Body: si el método elegido admite un cuerpo (como POST, PUT o PATCH), inserta los datos que serán enviados. El cuerpo de la solicitud puede estar en formatos como JSON, XML u otros, según la API.
Header: define los encabezados HTTP que deben incluirse en la solicitud, como Content-Type, Authorization, u otros, de acuerdo con las necesidades del servicio que se está integrando.
Query: inserta los parámetros de consulta (query parameters) que se agregarán a la URL. Estos parámetros suelen usarse para filtrar, ordenar o paginar los datos en la solicitud.

Luego, haz clic en "Próximo paso" (Estructura de salida).

SOAP

En los módulos del tipo SOAP, el área de Solicitud (Requisición) contiene los siguientes campos:

Parámetros disponibles: lista de los parámetros creados previamente.
Body: el cuerpo de la solicitud SOAP debe seguir el formato XML. En el body, es necesario incluir los parámetros que correspondan a la operación solicitada al servicio SOAP.
Header: los encabezados pueden incluir información de autenticación, como tokens, o datos de control de la transacción.

Luego, haz clic en "Próximo paso" (Estructura de salida).

Arquivo

En los módulos de tipo Archivo, el área de solicitud contiene los siguientes campos:

Parámetros disponibles: lista de los parámetros creados previamente.
Tipo de operación: las opciones disponibles son:
- Mover un archivo: Al seleccionar esta opción, la pantalla muestra los siguientes campos:
  - Ruta: especifica la ruta del directorio donde el archivo se encuentra actualmente.
  - Nombre: ingresa el nombre del archivo que será movido.
  - Ruta de destino: indica la nueva ruta a donde se moverá el archivo.
- Eliminar un archivo: Al seleccionar esta opción, la pantalla muestra los siguientes campos:
  - Ruta: especifica la ruta del directorio donde se encuentra el archivo que será eliminado.
  - Nombre: ingresa el nombre del archivo que será eliminado.
- Guardar archivo: Al seleccionar esta opción, la pantalla muestra los siguientes campos:
  - Ruta: indica la ruta del directorio donde se guardará el archivo.
  - Nombre: ingresa el nombre del archivo que será guardado.
  - Contenido: especifica el contenido que se guardará en el archivo.
  - Agregar el contenido si existe un archivo con el mismo nombre: marca esta opción si deseas añadir el nuevo contenido al archivo existente, en lugar de sobrescribirlo.
- Leer un archivo: Al seleccionar esta opción, la pantalla muestra los siguientes campos:
  - Ruta: especifica la ruta del directorio donde se encuentra el archivo.
    Nombre: ingresa el nombre del archivo que será leído.
    Formato del contenido del archivo: selecciona el formato del contenido del archivo (binario o texto).
- Listar archivos:
  - Ruta: especifica la ruta del directorio cuyos archivos serán listados.

Crear directorio:
- Ruta: especifica la ruta donde se creará el directorio.
- Directorio: ingresa el nombre del directorio.

Importante: Para garantizar el correcto funcionamiento de esta operación, verifica que tu Agente esté actualizado.

A continuación, haz clic en "Siguiente paso" (Estructura de salida).

RFC

En los módulos de tipo RFC, el área de solicitud contiene los siguientes campos:

Parámetros disponibles: lista de los parámetros creados previamente.
Nombre de la función: especifica el nombre de la función que será ejecutada en el sistema SAP.
Parámetro: ingresa los parámetros necesarios para la ejecución de la función seleccionada.

A continuación, haz clic en "Siguiente paso" (Estructura de salida).

Estructura de salida

En esta etapa, podrás probar la operación utilizando la información proporcionada. Para facilitar el proceso, las instrucciones están organizadas según el tipo de conectividad. Haz clic en la opción correspondiente:

Base de Datos

Para finalizar la configuración del módulo de tipo Base de Datos, la pantalla de "Estructura de salida" se divide en dos bloques: Entrada y Salida.