Guía de usuario de Marketplace

Última actualización 5 de sep. de 2024

Contenido

Estructura de tu Solution Accelerator

Tu Solution Accelerator debe ajustarse a la siguiente estructura de carpetas para mantener una experiencia coherente en todos los Solution Accelerators. Puede incluir cuatro carpetas:

Implementación (si la experiencia del usuario es Atendida, como Test Data Management, es posible que no se incluya)
Documentación
Bibliotecas (si el proceso no incluye ninguna biblioteca, es posible que no se incluya)
Procesos

Aunque ciertos elementos son coherentes en cada Solution Accelerator (como la estructura de carpetas), tu Solution Accelerator puede verse influido por el caso de uso específico y los productos UiPath utilizados en Solution Accelerator. En la siguiente tabla se describen los elementos coherentes dentro de cada Solution Accelerator:

Implementación	Documentación	Librerías	Procesos
Detalles del activo Detalles de la cola Paquete de gestión de soluciones Cualquier archivo NUPKG de la biblioteca Cualquier actividad personalizada adicional	Solution Accelerator: descripción general del acelerador Solution Accelerator: guía de implementación Solution Accelerator: documentación técnica Diseño de soluciones de alto nivel (.pdf y archivo de edición original como .vsdx) Diseño detallado de la solución (.pdf y archivo de edición original como .vsdx)	Subcarpetas individuales para cada biblioteca	Subcarpetas individuales para cada proceso

2. Carpeta de implementación

a. Detalles del activo

Los activos representan variables compartidas o credenciales que pueden utilizarse en diferentes proyectos de automatización en un Solution Accelerator. Detalles del activo es un archivo de libro de Microsoft Excel (.xlsx) compatible con Orchestrator Manager, una herramienta que aprovecha la API de Orchestrator para manipular entidades. Este libro permite a los usuarios ver y añadir fácilmente activos que se utilizan en tu Solution Accelerator.

Según el siguiente ejemplo, se espera que este libro tenga dos hojas: Crear para crear activos de texto, booleanos y enteros y Crear credencial para crear activos de credenciales. Los encabezados necesarios y el orden de los encabezados para cada hoja, junto con la información dentro de cada fila, se definen en las siguientes tablas.

Nombre de carpeta¹	Nombre del activo¹	Descripción¹	Ámbito¹	Nombre del robot o nombre de usuario del usuario¹	Tipo¹	Valor¹	ID de activo²	Resultado²
Procesamiento de órdenes de compra	`Dispatcher_PurchaseOrdersEmailsSourceAccount`	El buzón donde se encuentran los correos electrónicos de documentos de órdenes de compra que necesitamos procesar.	Global		Texto	PARA REEMPLAZAR CON UN VALOR ESPECÍFICO

¹⁾ La columna recibe información de la operación, como nombres, tipos y valores de los activos que se crearán.

²⁾ Columna utilizada por Orchestrator Manager para escribir datos recuperados de Orchestrator, como los ID de los activos creados. Los valores aquí se sobrescribirán en la siguiente operación Crear/Crear credencial .

Crear

Nombre de carpeta¹	Nombre del activo¹	Descripción¹	Ámbito¹	Nombre del robot¹ o nombre de usuario del usuario¹	Tipo¹	Valor¹	ID de activo²	Resultado²
Al especificar los nombres de las subcarpetas de las carpetas modernas, es necesario introducir el nombre completo de la carpeta principal, incluidos sus antecesores, separados por el carácter de barra diagonal (/). Ejemplo: si una Carpeta moderna llamada "GrupoDeTrabajo1" es una subcarpeta de una Carpeta moderna llamada "DepartamentoA", entonces el nombre completo del GrupoDeTrabajo1 es "DepartamentoA/GrupoDeTrabajo1".	El nombre del activo. El nombre debe tener un máximo de 256 caracteres.	Descripción del activo. La descripción debe tener un máximo de 250 caracteres.	El campo Ámbito tiene un número fijo de valores posibles, según los ámbitos de activos disponibles en Orchestrator: Global Robot (solo disponible en Carpetas clásicas) Usuario (solo disponible en Carpetas modernas).	Al crear activos por robot, utiliza el campo Nombre del robot o Nombre de usuario del usuario para especificar el nombre del robot que debe tener acceso al valor del activo que se está definiendo. El robot debe estar en la misma carpeta que el activo por robot creado. Los valores para varios robots deben especificarse en filas independientes con el mismo nombre de carpeta, nombre de activo, ámbito y tipo.	El campo Tipo tiene un número fijo de valores posibles, según los tipos de activos disponibles en Orchestrator: Texto Booleano Entero	El valor del activo. Si los valores de los activos deben ser definidos por el usuario, deben escribirse como "PARA REEMPLAZAR POR UN VALOR ESPECÍFICO". Este campo debe tener: un máximo de 1 000 000 de caracteres para los tipos de texto un valor entre 2147483648 y 2147483648 para tipos enteros un valor de VERDADERO o FALSO para los tipos Bool.	El ID del activo creado si el activo se crea correctamente.	El resultado de la creación del activo: correcto o fallido.

¹⁾ La columna recibe información de la operación, como nombres, tipos y valores de los activos que se crearán.

Crear credencial

Nombre de carpeta¹	Nombre del activo¹	Descripción¹	Ámbito¹	Nombre del robot o nombre de usuario del usuario¹	Nombre de usuario¹	Contraseña¹	ID de activo²	Resultado²
Al especificar los nombres de las subcarpetas de las carpetas modernas, es necesario introducir el nombre completo de la carpeta principal, incluidos sus antecesores, separados por el carácter de barra diagonal (/). Ejemplo: si una Carpeta moderna llamada "GrupoDeTrabajo1" es una subcarpeta de una Carpeta moderna llamada "DepartamentoA", entonces el nombre completo de "GrupoDeTrabajo1" es "DepartamentoA/GrupoDeTrabajo1".	El nombre del activo. El nombre debe tener un máximo de 256 caracteres.	Descripción del activo. La descripción debe tener un máximo de 250 caracteres.	El campo Ámbito tiene un número fijo de valores posibles, según los ámbitos de activos disponibles en Orchestrator: Global Robot (solo disponible en Carpetas clásicas) Usuario (solo disponible en Carpetas modernas).	Al crear activos por robot, utiliza el campo Nombre del robot o Nombre de usuario del usuario para especificar el nombre del robot que debe tener acceso al valor del activo que se está definiendo. El robot debe estar en la misma carpeta que el activo por robot creado. Los valores para varios robots deben especificarse en filas independientes con el mismo nombre de carpeta, nombre de activo, ámbito y tipo.	El campo de nombre de usuario. Como lo proporcionan los usuarios finales, este campo siempre debe contener "PARA REEMPLAZAR POR UN VALOR ESPECÍFICO" en cada fila.	El campo de contraseña. Como lo proporcionan los usuarios finales, este campo siempre debe contener "PARA REEMPLAZAR POR UN VALOR ESPECÍFICO" en cada fila.	El ID del activo creado si el activo se crea correctamente.	El resultado de la creación del activo: correcto o fallido.

¹⁾ La columna recibe información de la operación, como nombres, tipos y valores de los activos que se crearán.

b. Detalles de la cola

Una cola es un contenedor que te permite retener un número ilimitado de elementos. Los artículos en cola pueden almacenar varios tipos de datos, como información de facturas o detalles del cliente. Las colas te permiten crear grandes proyectos de automatización, como aceleradores de soluciones, subrayados por una lógica compleja.

Detalles de cola es un archivo de libro de Microsoft Excel (.xlsx) compatible con Orchestrator Manager, una herramienta que aprovecha la API de Orchestrator para manipular entidades. Este libro permite a los usuarios ver y añadir fácilmente las colas que se utilizan en su Solution Accelerator

Según el siguiente ejemplo, se espera que este libro tenga una hoja: Crear para crear todas las colas. Los encabezados necesarios y el orden de los encabezados de la hoja, junto con la información dentro de cada fila, se definen en la siguiente tabla. Las columnas de encabezado naranja reciben información de la operación, como nombres, descripción y número máximo de reintentos de colas que se crearán. Orchestrator Manager utiliza las columnas de encabezado gris para escribir los datos recuperados de Orchestrator, como los ID de las colas creadas. Los valores aquí se sobrescribirán en la siguiente operación Crear.

Nombre de la carpeta	Nombre de cola	Descripción	Unique Reference	Auto Retry	Max # of Retries	ID de activo	Resultado
Al especificar los nombres de las subcarpetas de las carpetas modernas, es necesario introducir el nombre completo de la carpeta principal, incluidos sus antecesores, separados por el carácter de barra diagonal (/). Ejemplo: si una Carpeta moderna llamada "GrupoDeTrabajo1" es una subcarpeta de una Carpeta moderna llamada "DepartamentoA", entonces el nombre completo del GrupoDeTrabajo1 es "DepartamentoA/GrupoDeTrabajo1".	El nombre de la cola. El nombre no puede tener ningún espacio en blanco. El nombre debe tener un máximo de 50 caracteres.	Descripción de la cola. La descripción debe tener un máximo de 250 caracteres.	Hace que las transacciones tengan referencias únicas. Debe ser Sí o No.	Permite que un elemento de transacción dentro de la cola que falle con una excepción del sistema se vuelva a intentar automáticamente. Debe ser Sí o No.	El número máximo de reintentos para un elemento de transacción dentro de la cola. Debe ser al menos 1 si Reintento automático es Sí. Puede ser un número entero entre 1 y 50.	El ID de la cola creada si la cola se crea correctamente.	El resultado de la creación de la cola: éxito o fracaso.

c. Paquete de gestión de soluciones

Un Solution Accelerator es un paquete de múltiples componentes (procesos, activos, colas, etc.) desarrollados en la plataforma UiPath, que trabajan juntos para automatizar un caso de uso empresarial. UiPath Solutions Management proporciona un medio listo para usar para gestionar el ciclo de vida de los componentes de Solution Accelerator una vez creados. Este conjunto de capacidades entra en juego una vez finalizado el desarrollo de tu Solution Accelerator, y deseas promover fácilmente sus componentes a un nuevo entorno.

La gestión de soluciones te permite empaquetar cómodamente estos componentes en un único archivo dentro del entorno de Orchestrator en el que se ha desarrollado Solution Accelerator. Para obtener una guía sobre cómo crear un paquete de gestión de soluciones, consulta Crear un proyecto de solución.

Algunos requisitos y consideraciones al crear un paquete de gestión de soluciones para tu acelerador de soluciones:

Cualquier Activo que sea Credencial debe contener un campo Nombre de usuario y Contraseña que tengan valores de "PARA REEMPLAZAR POR UN VALOR ESPECÍFICO", ya que estos son proporcionados por los usuarios finales.
Cualquier activo que sea específico del usuario final, como las direcciones de correo electrónico de destino o las URL del entorno, también debe tener valores de "PARA REEMPLAZAR POR UN VALOR ESPECÍFICO".
La convención de nomenclatura para el Zip de gestión de soluciones debe ser "Solution Accelerator Name 1.0.0" donde Solution Accelerator Name es el nombre del Solution Accelerator y donde 1.0.0 es la versión del proyecto de solución para el zip de Solution Management.
Todos los depósitos de almacenamiento y desencadenadores se incluirán en el zip de gestión de soluciones. Los Depósitos de almacenamiento y los Desencadenadores no se pueden incluir en las implementaciones manuales y se debe indicar que se crearán manualmente en la documentación de la Guía de implementación.
Los procesos NO deben incluirse en el zip de Solution Management. Se espera que los procesos no funcionen inmediatamente sin modificaciones para las mejoras específicas del entorno y del procedimiento en un Acelerador de soluciones.
Si se espera que una biblioteca personalizada se modifique pase lo que pase, no debe incluirse en el paquete de gestión de soluciones, ya que no funcionará de inmediato sin modificaciones.

d. Archivos NUPKG de biblioteca

Una biblioteca es un proyecto que contiene uno o más flujos de trabajo que pueden reutilizarse como actividades en otros proyectos. Esto permite que tu Solution Accelerator utilice código común en cada proceso individual. Para obtener información sobre la creación de una biblioteca, consulta la sección Crear una biblioteca en la documentación de la biblioteca. Para obtener información sobre los estándares de desarrollo en la creación de una biblioteca para aceleradores de soluciones, consulta la sección de desarrollo de bibliotecas. Una biblioteca se guarda como archivo NUPKG cuando se publica y se puede instalar como una dependencia desde el Administrador de paquetes. Puedes publicar una biblioteca en una carpeta local o publicar y descargar desde la fuente del paquete NuGet para recuperar el archivo NUPKG relevante.

Importante:

Si una biblioteca reutilizable está diseñada para funcionar sin necesidad de ninguna modificación, inclúyela en la carpeta Implementación.

Si se espera que la biblioteca se modifique para que funcione correctamente dentro del proyecto, se espera que no se incluya en la carpeta Implementación y la Guía de implementación debe dejar claro que la biblioteca debe modificarse, publicarse y actualizarse las dependencias en cualquier proyecto que utilice esa biblioteca.

Si una biblioteca reutilizable se publica por separado en una fuente, como UiPath Solution Accelerators Generic Reusables, no es necesario incluir el archivo NUPKG.

e. Cualquier actividad personalizada adicional

Puedes crear tus propias actividades personalizadas que pueden utilizarse en proyectos de UiPath Studio. Para utilizar las actividades personalizadas que se crean, debes instalar el paquete NuGet que lo contiene en los proyectos de Solution Accelerator accediendo al Gestor de paquetes desde UiPath Studio e instalando el NUPKG. Ese paquete NuGet debe crearse al finalizar la actividad personalizada. El NUPKG puede incluirse dentro de la carpeta Implementación de Solution Accelerator.

3. Documentación

La estructura de la documentación debe seguir las siguientes directrices:

Solution Accelerator: descripción general del acelerador
Solution Accelerator: guía de implementación
Solution Accelerator: documentación técnica
Diseño de soluciones de alto nivel (.pdf y archivo de edición original como .vsdx)
Diseño detallado de la solución (.pdf y archivo de edición original como .vsdx)

4. Bibliotecas

Una biblioteca de UiPath es un proyecto que contiene uno o más flujos de trabajo que pueden reutilizarse como actividades en otros proyectos. Las bibliotecas se guardan como archivos NUPKG cuando se publican y pueden instalarse como dependencias desde el Administrador de paquetes. Una biblioteca solo puede desarrollarse utilizando un tipo de proyecto de biblioteca. Cualquier componente de IU reutilizable también debe implementarse dentro de una biblioteca utilizando el repositorio de objetos. Cualquier entidad de Data Service debe importarse dentro de una biblioteca para que se pueda utilizar la misma referencia/espacio de nombres en todo el Solution Accelerator importando una biblioteca. Al importar dentro de una biblioteca, los espacios de nombres no entrarán en conflicto en los diferentes procesos.

Una biblioteca tiene los siguientes requisitos:

Tipo de proyecto	Proyectos de biblioteca
Tamaño del proceso y convención de nomenclatura del flujo de trabajo	XAML pequeños y bien definidos Denominación: utiliza una denominación "Escribir en mayúsculas cada palabra" (espacios intermedios) y no PascalCase. Si se prefiere PascalCase para los flujos de trabajo, la convención "Poner en mayúscula cada palabra" (restaurar los espacios al nombre de la actividad) aún se puede realizar a través del campo "Mostrar nombre" del "Diseño de la actividad" (haz clic con el botón derecho en la opción de menú Flujo de trabajo en el Explorador de proyectos ).
Anotaciones	Añadir anotaciones ancladas en cada archivo de flujo de trabajo como descargo de responsabilidad/explicación Anotar actividades con una explicación descriptiva adecuada
Convención de denominación de variables	Minúscula Camel (p. ej., firstName, lastName, myOrganizationStructure)
Convención de denominación de argumentos	Los argumentos deben nombrarse utilizando el estándar PascalCase . El nombre de los argumentos NO debe contener el prefijo in_/out_/io_ porque esos argumentos aparecerán como propiedades cuando se cree la biblioteca. Deben existir anotaciones para cada argumento, ya que esto se muestra cuando se utiliza una actividad de Biblioteca
Resultados del argumento	Un flujo de trabajo de biblioteca debe hacer lo que se describe en el nombre del flujo de trabajo Un flujo de trabajo debe analizar cualquier resultado de API o GUI y devolver el resultado de datos específico
Comentarios	Agregue comentarios para aumentar la legibilidad de los proyectos de la biblioteca
Entidad de Data Service	Las entidades de Data Service pueden importarse dentro de una biblioteca. El espacio de nombres debe ser el nombre de la entidad. Las operaciones de Data Service pueden ocurrir en una biblioteca para mejorar la reutilización de la entidad en todo el Solution Accelerator.
Manejo de excepciones	Los errores dentro de una biblioteca deben lanzarse como excepciones en lugar de señalarse mediante argumentos de salida. Confirme el resultado de un componente de biblioteca al final comprobando si se ha producido la acción deseada y lanzando una excepción si no es así.

5. Procesos

Un proceso es un proyecto de UiPath desarrollado utilizando la opción de diseño de procesos que puede ser ejecutado por un UiPath Robot. Cualquier nuevo proyecto de proceso debe ser un proyecto multiplataforma o un proyecto de Windows. Windows (heredado) utiliza una versión anterior de .NET Framework y ya no será una opción para nuevos proyectos en un futuro próximo. Las entidades de Data Service no deben importarse dentro de un proceso. Importar dentro de un proceso individual puede causar espacios de nombres en conflicto en un Solution Accelerator.

Un proceso tiene los siguientes requisitos:

Tipo de proyecto	Proyectos Windows Proyectos multiplataforma
Tamaño del proceso	Procesos pequeños y bien delimitados
Anotaciones	Añade anotaciones ancladas en cada archivo de flujo de trabajo como descargo de responsabilidad/explicación. El formato típico describe cuál es el propósito del flujo de trabajo junto con una explicación de cada argumento para enviar, enviar y enviar/salir Anotar actividades con una explicación descriptiva adecuada
Convención de denominación de variables	Mantener una convención de nomenclatura de variables coherente a lo largo de un proceso de automatización es importante para la legibilidad y la claridad El estándar típico que siguen los desarrolladores de UiPath es Minúscula Camel (por ejemplo, firstName, myFirstName, lastName, myOrganizationStructure)
Convención de denominación de argumentos	Minúscula Camel con un prefijo que indica el tipo de argumento como in, out o in/out, como in_defaultTimeout, in_fileName, out_textResult, io_retryNumber. Las anotaciones deben existir para cada argumento, ya que se muestran cuando se invoca un flujo de trabajo
Comentarios	Agregue actividades de comentarios en los lugares adecuados para resaltar áreas de configuración/donde la lógica debe cambiarse en función de los escenarios del cliente
Entidad de Data Service	Las entidades de Data Service no deben importarse dentro de un proceso. Una entidad de Data Service debe importarse dentro de una biblioteca común para evitar conflictos de espacios de nombres. Las operaciones de Data Service pueden ocurrir en un proceso con un espacio de nombres que se importa desde una biblioteca.
Capas	Capa de aplicación (se puede utilizar API o Automatización de IU para una aplicación específica, sin embargo, esto queda a discreción del desarrollador) Capa de lógica empresarial/capa de implementación