Generar páginas de Receta y Editar Receta en Jitterbit Citizen Integrator

Introducción

Citizen Integrator, accesible a través del portal Harmony, es la aplicación web de Jitterbit para usuarios no técnicos que permite personalizar y desplegar rápidamente integraciones de Design Studio utilizando recetas preconstruidas de Citizen Integrator.

Dentro de Citizen Integrator, se puede subir un proyecto de Design Studio para generar una receta de Citizen Integrator y luego configurar los pasos de la receta en la página de Generar Receta. Para recetas existentes, la página de Editar Receta también hace que esos pasos estén disponibles para edición.

Acceder a la página de generar receta

La opción para generar una receta de Citizen Integrator está disponible desde la página de Citizen Integrator - Mis recetas. Después de la generación de la receta, se te llevará a la página de Generar Receta para configurar más a fondo los pasos de tu receta.

Desde la página de Mis Recetas, en la sección de Mis Recetas, la opción para generar una receta está disponible solo para usuarios con permisos de Admin dentro de la organización seleccionada.

Haz clic en el ícono JPK para abrir una ventana donde puedes subir un Jitterpak de Design Studio que generará una receta.

En la ventana Generar Receta, utiliza el botón Elegir Archivo para buscar el Jitterpak (.JPK) que deseas subir.

Luego haz clic en Enviar para generar tu nueva receta y abrir la página Generar Receta donde puedes configurar más a fondo los pasos de tu receta (ver Generar o editar pasos de receta a continuación).

Acceder a la página de edición de receta

La opción para editar una receta de Citizen Integrator está disponible desde la página Citizen Integrator - Mis recetas.

Desde la página Mis Recetas, en la sección Mis Recetas, la opción para editar una receta estará disponible una vez que hayas seleccionado solo una receta dentro de la tabla, y estará disponible solo para usuarios con permisos de Administrador dentro de la organización seleccionada.

Para seleccionar una receta, haz clic en cualquier parte de la fila, o marca la casilla a la izquierda de la receta.

Luego haz clic en el ícono de editar para abrir la página Editar Receta donde puedes actualizar los pasos de tu receta (ver Generar o editar pasos de receta a continuación).

Generar o editar pasos de receta

Una vez que hayas accedido a las páginas Generar Receta o Editar Receta como se describió anteriormente, puedes configurar los pasos de la receta a través de la interfaz de usuario de Citizen Integrator de la siguiente manera.

Nombre y descripción de la receta

En la primera sección, ingresa el nombre y la descripción básica de tu receta.

• Nombre de la Receta: Proporciona o modifica el nombre de tu receta.
• Descripción de la Receta: Proporciona o modifica la descripción de tu receta.

Variables del proyecto de receta

La siguiente sección se utiliza para agregar cualquier variable de proyecto a la receta para que los usuarios puedan establecer valores al usar la receta. Para más información, consulta Variables.

Eliminar o restaurar variables del proyecto

En el lado izquierdo, se enumerarán las variables del proyecto existentes.

• Generar Receta: Al generar una receta, se muestran todas las variables del proyecto del archivo Jitterpak. Si no se incluyen variables del proyecto en el Jitterpak, no se mostrarán.
• Editar Receta: Al editar una receta, se muestran las variables del proyecto existentes del metadato JSON de la receta o de la receta generada anteriormente.

Para eliminar una variable del proyecto de la receta, haz clic en el ícono de papelera junto al nombre de la variable del proyecto en el lado izquierdo.

Para restaurar una variable del proyecto que has eliminado previamente, utiliza el menú desplegable en la parte superior derecha para seleccionar una variable eliminada anteriormente y haz clic en el botón Restaurar Variable.

Configurar variables del proyecto

En el lado derecho, los campos para la variable seleccionada están disponibles para ser configurados.

• Nombre: El nombre de tu variable del proyecto existente no es editable.

• Nombre para Mostrar: Este campo se puede usar si deseas un nombre diferente para mostrar en la interfaz de Citizen Integrator.

• Descripción: Este campo se puede usar para insertar texto debajo del campo, por ejemplo, para proporcionar instrucciones sobre lo que los usuarios deben ingresar.

• Valor: Este campo se puede usar si deseas asignar un valor predeterminado a tu variable del proyecto. Esto se puede usar para proporcionar un valor predeterminado con otros valores opcionales para la variable del proyecto. Por ejemplo, un valor predeterminado de "Producción" con otras opciones para "Desarrollo" o "QA." Estas opciones se proporcionan bajo el campo Tipo.

• Expresión Regular: Este campo se puede utilizar para proporcionar una expresión regular (cadena) que el valor de la variable del proyecto debe coincidir cuando se configura la receta antes de que se puedan utilizar las acciones de Probar Conexión o Ejecutar Operación. Por ejemplo: ".+@.+[.].+".

• Tipo: Este campo se puede utilizar para definir el tipo de valor que el usuario puede proporcionar. Utilice el menú desplegable para seleccionar entre texto, contraseña, casilla de verificación, menú desplegable o área de texto. Para casillas de verificación y menús desplegables, se vuelven disponibles opciones adicionales para configurar. Ingrese una Etiqueta y Valor para cada selección o use el ícono de papelera para eliminar una fila.

  

• Campo Requerido: Si esta casilla está marcada, se requerirá completar el campo de variable del proyecto cuando se configure la receta antes de que se puedan utilizar las acciones de Probar Conexión o Ejecutar Operación.

Pasos de la receta

La siguiente sección se utiliza para configurar los pasos que los usuarios deberán seguir para configurar la receta del Integrador Ciudadano.

Agregar o eliminar pasos

En el lado izquierdo, se enumerarán los pasos de receta existentes.

• Generar Receta: Al generar una receta, los pasos de Introducción y Revisión se agregan por defecto.
• Editar Receta: Al editar una receta, se muestran los pasos existentes de los metadatos JSON de la receta o de la receta generada previamente.

Para eliminar un paso de la receta, haga clic en el ícono de papelera junto al nombre del paso en la izquierda. Los pasos de Introducción y Revisión, así como cualquier paso generado automáticamente, no se pueden eliminar.

Para agregar un nuevo paso, haga clic en el botón Agregar Nuevo Paso en la parte superior derecha. Se creará un nuevo paso antes del paso de Revisión.

Configurar pasos

En el lado derecho, los campos para el paso seleccionado están disponibles para ser configurados. Los siguientes campos son comunes para todos los tipos de pasos:

• Nombre del Paso: Ingrese un nombre para el paso que aparecerá dentro de la receta (por ejemplo, Introducción o Autenticación de Salesforce).
• Tipo: Seleccione uno de los siguientes tipos de paso:
  • Descripción: Se utiliza para proporcionar información sobre la receta y/o sus componentes.
  • Configuración del Paso: Se utiliza para definir una o más variables de proyecto para verificar la conectividad para un punto final específico.
  • Ejecutar Operación: Se utiliza para ejecutar una operación antes de que la receta se despliegue.
  • Vinculación de API: Se utiliza cuando hay necesidad de externalizar operaciones como APIs.
• Descripción: Ingrese una descripción del paso que aparecerá dentro de la receta.

Cada tipo de paso y cualquier campo que se vuelva disponible cuando se selecciona el paso se cubren en detalle a continuación.

• Descripción: Este tipo de paso se utiliza para proporcionar información sobre la receta y/o sus componentes.
  • Detalles: Ingresa cualquier HTML aquí que desees que se renderice dentro de este paso.

• Configuración del Paso: Este tipo de paso se utiliza generalmente para probar una conexión de endpoint.

  • Requerido: Marca esta casilla si deseas que este paso sea completado antes de desplegar la receta (por ejemplo, para probar o validar que una conexión de endpoint es exitosa).
  • Variable(s) del Proyecto: Usa el menú desplegable para agregar variables del proyecto al paso, o usa el ícono de papelera para eliminarlas. Las variables del proyecto se configuran en la sección anterior.

  • Acción: Marca esta casilla si deseas incluir una acción dentro del paso (por ejemplo, probar la conexión usando las credenciales proporcionadas). Cuando se marca, los siguientes campos adicionales se vuelven disponibles:

    • Nombre del Botón: Ingresa un nombre que aparecerá en el botón de acción (por ejemplo, Probar Conexión).
    • Acción del Paso: Usa el menú desplegable para seleccionar una acción. Todos los endpoints existentes del archivo Jitterpak se enumerarán en el menú desplegable.

    Después de seleccionar una acción, un paso de acción se agregará automáticamente bajo el paso actual. Luego necesitarás hacer clic en el paso autogenerado en la lista de pasos a la izquierda para configurar los detalles del paso. Se proporciona más información bajo el tipo de paso autogenerado a continuación.

• Ejecutar Operación: Este tipo de paso se utiliza para ejecutar una operación del archivo Jitterpak.

  • Requerido: Marca esta casilla si deseas que este paso sea completado antes de desplegar la receta.
  • Ruta de la Operación: Todas las operaciones existentes del archivo Jitterpak se enumerarán aquí. Selecciona la operación que deseas ejecutar en esta parada.
  • Descripción de la Operación: Ingresa una descripción sobre la operación seleccionada para proporcionar información en la receta sobre lo que hace la operación.
• Vinculación de API: Este tipo de paso se utiliza cuando hay necesidad de externalizar operaciones como APIs. Los campos deben contener la información necesaria para la API. Consulta API Manager para más información.

• Paso Autogenerado: Este tipo de paso se crea automáticamente cuando eliges el tipo Configuración del Paso y marcas la casilla Acción con una Acción del Paso seleccionada.

  • Ejecutar operación: Consulta el paso de Ejecutar operación anterior para obtener información sobre los campos configurables.

  • Probar conexiones: Todas las variables necesarias se muestran según la acción seleccionada. Puedes codificar un valor predeterminado o usar variables de proyecto configuradas en la sección anterior.

    

    • Valor predeterminado: Escribe un valor predeterminado en el cuadro de texto para codificar el valor de la variable. Los usuarios no podrán cambiar este valor al implementar una receta.
    • Variable de proyecto: Marca la casilla de verificación y utiliza el menú desplegable para seleccionar una variable de proyecto que hayas configurado en la sección anterior.

Post-configuración

Una vez que hayas configurado tu receta de Citizen Integrator generada o editada como se describe arriba, utiliza los botones en la parte inferior de la página cuando estés listo.

• Vista previa: Usa este botón para ver una vista previa del archivo JSON generado que se utilizará para tu receta.

  

• Guardar en archivo: Usa este botón para descargar el archivo JSON generado.

• Cancelar: Usa este botón para cerrar la página sin guardar cambios.

• Subir / Actualizar: Estos botones validarán la receta y la subirán a la organización seleccionada (en la página de Generar receta) o actualizarán la receta (en la página de Editar receta).