Plantilla de guía del usuario para listados

Información general para todos los tipos de listados

Introducción: propósito del listado

• En esta sección, describa brevemente su listado y para qué sirve.
• Añade cualquier vídeo, demostración y captura de pantalla relevante que muestre las capacidades del listado.
• Especifique la compatibilidad con UiPath Studio.

Casos de uso

En esta sección, explicaremos cómo se utilizará el listado en un proceso empresarial y sus ventajas. ¿Qué problema soluciona?

Requisitos previos si corresponde

En esta sección, mencione cualquier artefacto o software que deba descargarse de otras fuentes antes de la configuración. Por ejemplo:

• URL para descargar software o plataforma de terceros;
• URL para obtener la clave o licencia de API;
• Versión de software;
• Cualquier otra dependencia, dónde encontrarla y cómo instalarla y configurarla.

Configuración si corresponde

En esta sección, menciona los pasos para preparar el entorno antes de utilizar el listado.

Si se debe generar una nueva clave o licencia, proporcione los pasos.

Ejemplo: estos son los pasos para generar la clave para usar la API de dirección de Google:

• Inicie sesión en su cuenta de Google.
• Vaya a https://console.developers.google.com.
• Active su prueba gratuita.
• De acuerdo y continúe.
• Proporcione su dirección y los detalles de su tarjeta (no se realizará ningún cargo automático una vez finalice la prueba gratuita).
• Haga clic en el logotipo de la "API de Google" para ir a la página de inicio.
• Haga clic en "Credenciales"> Crear credenciales.
• Elija "Clave API".
• Anote la clave API (esta es la clave que se utilizará en la automatización).
• Para habilitar la 'API de Dirección', haga clic en el logotipo de la API de Google para ir a la página de inicio.
• Haga clic en "Habilitar APIS y servicios".
• Busque 'API de Dirección'.
• Habilítelo.

Si debe ejecutar cualquier script de PowerShell, incluya una captura de pantalla relevante con la ejecución del script.

Cualquier otro paso de configuración necesario, con capturas de pantalla donde corresponda.

Información por tipo de listado

Actividades personalizadas

En esta sección, proporciona una breve descripción de cada actividad incluida. Además, debe explicarse en detalle cada parámetro de cada actividad.

Las capturas de pantalla para mostrar diferentes actividades y formas de configurarlas también ayudarán a los usuarios a recibir la información con facilidad.

Ámbito de la plataforma

• Proporciona una breve descripción de la actividad.
• Esta actividad es la que asegura la conexión entre cada actividad contenida en este paquete y la plataforma. Cada actividad debe colocarse dentro de esta actividad principal.

Entrada

• URL (cadena): esta es la URL de la plataforma que puedes obtener visitando tu Perfil de cuenta> API> URL
• Token de API (cadena): este es el token de API que está disponible en Perfil de cuenta> API> Credenciales

Salida

• Token (cadena): este es el token que se generará para que pueda usarse en cada solicitud

Ejemplos:

• En esta sección, menciona los pasos sobre cómo utilizar la automatización con UiPath Studio.
• Para las actividades personalizadas, un ejemplo de los valores de formato de entrada que se pasan a las propiedades.
• Para las actividades personalizadas que contengan varias actividades, si hay un orden específico en el que deban utilizarse estas actividades, incluya una captura de pantalla de un flujo de trabajo de muestra que muestre este uso de las actividades, por ejemplo, en la siguiente captura de pantalla Actividad, Crear documento, Crear destinatario, Definir sobre , Enviar sobre y Descargar sobre forman parte del mismo paquete de actividades personalizadas.

Fragmentos

En esta sección, añada lo siguiente:

• Una breve descripción de cada uno de los archivos de flujo de trabajo.
• Una breve descripción sobre el archivo de configuración (si corresponde).
• Todos los parámetros para cada uno de los XAML deben explicarse en detalle.

Plantilla / solución de flujo de trabajo

En esta sección, describa brevemente la plantilla. Cuáles son las prácticas recomendadas, el número y el objetivo de los diferentes flujos de trabajo.

Informar sobre los argumentos y variables utilizados y los pasos necesarios para la configuración.

Ejemplo:

Robotic Enterprise Framework es una plantilla de proyecto basada en State Machines. Está creado para adaptarse a las mejores prácticas relacionadas con el registro, el manejo de excepciones, la inicialización de aplicaciones y otros, estando listo para hacer frente a un escenario empresarial complejo.

La plantilla contiene varios contenedores de Estado prefabricados para inicializar aplicaciones, recuperar datos de entrada, procesarlos y finalizar la transacción. Todos estos estados están conectados a través de múltiples Transiciones que cubren casi cualquier necesidad en un escenario de automatización estándar. También hay múltiples flujos de trabajo invocados, cada uno de los cuales gestiona aspectos concretos del proyecto.