Modèle de guide de l'utilisateur pour les listes

Informations générales pour tous les types de listes

Introduction – Objectif de la liste

• Dans cette section, décrivez brièvement votre liste et à quoi sert-elle.
• Ajoutez toutes les vidéos, démos et captures d'écran pertinentes qui présentent les capacités de la liste.
• Spécifiez la compatibilité avec UiPath Studio.

Cas d'utilisation

Dans cette section, expliquez comment la liste sera utilisée dans un processus métier et quels sont ses avantages. Quel problème résout-il ?

Prérequis, le cas échéant

Dans cette section, veuillez mentionner tout artefact ou logiciel à télécharger à partir d’autres sources avant la configuration. Par exemple :

• URL pour télécharger un logiciel ou une plate-forme tiers ;
• URL pour obtenir la clé API ou la licence ;
• Version du logiciel ;
• Toute autre dépendance, où la trouver, et comment l'installer et la configurer.

Configurer le cas échéant

Dans cette section, mentionnez les étapes de préparation de l'environnement avant d'utiliser la liste.

Si une nouvelle clé ou licence doit être générée, veuillez indiquer les étapes à suivre.

Exemple : voici les étapes à suivre pour générer la clé d'utilisation de l'API Google Direction :

• Connectez-vous à votre compte Google.
• Rendez-vous sur https://console.developers.google.com.
• Activez votre essai gratuit.
• Accepter et continuer.
• Indiquez votre adresse et les détails de votre carte (pas de débit automatique après la fin de l'essai gratuit).
• Cliquez sur le logo « Google API » pour accéder à la page d’accueil.
• Cliquez sur « Informations d’identification » (Credentials) > Créer des informations d’identification (Create Credentials).
• Choisissez "Clé API (API Key)".
• Notez la clé API (il s’agit de la clé à utiliser dans l’automatisation).
• Pour activer « Direction API », cliquez sur le logo Google API pour accéder à la page d’accueil.
• Cliquez sur « Activer les APIS et les services » (Enable APIS and services).
• Recherchez « Direction API ».
• Activez-la.

Si un script PowerShell doit être exécuté, incluez une capture d'écran pertinente avec l'exécution du script.

Toutes les autres étapes de configuration nécessaires, avec captures d'écran, le cas échéant.

Informations par type de liste

Activités personnalisées (Custom Activities)

Dans cette section, décrivez brièvement chaque activité incluse. De plus, chaque paramètre de chaque activité doit être expliqué en détail.

Des captures d'écran présentant les différentes activités et les façons de les configurer aideront également les utilisateurs à recevoir les informations facilement.

Étendue de la plate-forme

• Fournissez une brève description de l'activité.
• Cette activité est celle qui assure la connexion entre chaque activité contenue dans ce package et la plate-forme. Chaque activité doit être placée à l’intérieur de cette activité parente.

Entrée

• URL (String) : il s'agit de l'URL de la plate-forme que vous pouvez obtenir en vous rendant sur Profil du compte (Account Profile) > API > URL (URL)
• Jeton API (String) : il s'agit du jeton API disponible dans Profil du compte (Account Profile) > API > Informations d'identification (Credentials)

Sortie

• Jeton (chaîne) : il s'agit du jeton qui sera généré afin qu'il puisse être utilisé dans chaque requête

Exemples :

• Dans cette section, mentionnez les étapes d'utilisation de l'automatisation à l'aide d'UiPath Studio.
• Pour les activités personnalisées, un exemple des valeurs de format d'entrée transmises aux propriétés.
• Pour les activités personnalisées contenant plusieurs activités, s'il existe un ordre spécifique dans lequel ces activités doivent être utilisées, incluez une capture d'écran d'un exemple de workflow montrant cette utilisation des activités, par exemple dans la capture d'écran suivante Activité Scope, Créer un document, Créer un destinataire, Définir une enveloppe , Envoyer l'enveloppe, Télécharger l'enveloppe font tous partie du même package d'activités personnalisées.

Extraits

Dans cette section, veuillez ajouter les éléments suivants :

• Une brève description de chacun des fichiers de workflow.
• Une brève description du fichier de configuration (le cas échéant).
• Tous les paramètres de chacun des XAML doivent être expliqués en détail.

Modèle de workflow/solution

Dans cette section, veuillez décrire brièvement le modèle. Quelles sont les meilleures pratiques utilisées, le nombre et le but des différents workflows.

Informations sur les arguments et les variables utilisés et les étapes nécessaires à la configuration.

Exemple :

L'infrastructure d'entreprise robotique (Robotic Enterprise Framework) est un modèle de projet basé sur les Machines à états (State Machines). Elle est créée pour répondre à toutes les meilleures pratiques concernant la journalisation, le traitement des exceptions, l'initialisation des applications, etc. Elle est prête pour gérer un scénario métier complexe.

Le modèle contient plusieurs conteneurs State prédéfinis pour l'initialisation des applications, la récupération des données d'entrée, leur traitement et la fin de la transaction. Tous ces états sont connectés via plusieurs transitions qui couvrent pratiquement tous les besoins dans un scénario d'automatisation standard. Il existe également plusieurs workflows invoqués, chacun gérant des aspects spécifiques du projet.