Documentation du produit

Pour pouvoir utiliser la documentation hors ligne, procurez-vous les fichiers de documentation du paquet du produit Kofax RPA que vous avez téléchargé sur le site de distribution Kofax.

Le paquet du produit comprend les fichiers de documentation suivants pour une utilisation hors ligne :

• KofaxRPADocumentation_11.4.0_EN.zip

  Contient l'ensemble de la documentation Kofax RPA en anglais.

• KofaxRPADocumentation_11.4.0_JA.zip

  Contient l'ensemble de la documentation Kofax RPA en japonais, à l'exception de la documentation de l'API Java.

• KofaxRPADocumentation_11.4.0_FR.zip

  Contient l'ensemble de la documentation Kofax RPA en français, à l'exception de la documentation de l'API Java.

• KofaxRPAManagementConsoleDocumentation-11.4.0.zip

  Contient la documentation sur la Management Console et les Kapplets en anglais, japonais et français.

Après avoir installé le produit Kofax RPA, procédez comme suit :

1. Décompressez le contenu du fichier KofaxRPADocumentation.zip pour la langue dont vous avez besoin vers un emplacement sur votre ordinateur.

   Ensuite, renommez le dossier décompressé en EN, JA ou FR, selon le code de langue spécifié dans le nom du fichier .zip. Par exemple, KofaxRPADocumentation_11.4.0_EN doit être renommé en EN.

   Le dossier décompressé de chaque langue contient les dossiers suivants :

   • api
   • help
   • print
   • resources

2. Décompressez le contenu du fichier KofaxRPAManagementConsoleDocumentation.zip vers un emplacement sur votre ordinateur.

   Vous n'avez pas besoin de renommer le dossier décompressé.

   Le dossier décompressé contient le fichier KofaxRPAManagementConsoleDocumentation.war qui inclut la documentation dans les trois langues.

Lorsque la documentation hors ligne est installée pour un composant RPA conformément aux instructions ci-dessous, le composant utilise par défaut la version hors ligne de la documentation, même si une connexion Internet active existe.

Documentation de l'API hors ligne

Le dossier que vous avez extrait de l'un des fichiers KofaxRPADocumentation ZIP contient les références de l'API en anglais. Vous pouvez accéder à la documentation de l'API RoboSuite Java et RoboSuite .NET depuis ce dossier.

Documentation hors ligne de la Design Studio

1. Accédez à l'emplacement où vous avez renommé le dossier de documentation décompressé.

2. Copiez le dossier EN, JA ou FR dans le dossier documentation au sein des fichiers du produit :

   Exemple : C:\Program Files\Kofax RPA 11.4.0.0\documentation

3. Lancez Design Studio et accédez à Paramètres > Paramètres Design Studio.

4. Sur l'onglet Général, dans Emplacement de la documentation, sélectionnez Hors ligne dans la liste.

5. Enregistrez les modifications.

Pour passer en mode En ligne, sélectionnez En ligne dans Paramètres Design Studio et enregistrez les modifications.

Documentation hors ligne de la Management Console

1. Accédez à l'emplacement contenant le fichier extrait KofaxRPAMagementConsoleDocumentation.war.

   Le fichier .war inclut la documentation dans les trois langues, et la documentation à utiliser dépendra de la langue sur laquelle la Management Console est définie.

2. Copiez le fichier dans :

   C:\<dossier d'installation Tomcat>\Tomcat <version>\webapps

3. Démarrez la Management Console.

4. Ouvrez Paramètres > Général > URL de base.

5. Sélectionnez Utiliser la documentation locale. Dans URL de base de la documentation locale, indiquez l'URL du site web Tomcat contenant la documentation.

   Exemple : http://localhost:8080/KofaxRPAManagementConsoleDocumentation

6. Enregistrez les modifications.

Vous devrez peut-être actualiser la Management Console pour que les changements prennent effet.

Pour passer en mode En ligne, désactivez Utiliser la documentation locale dans les paramètres URL de base et enregistrez les modifications.

Documentation hors ligne du service Desktop Automation

1. Accédez à l'emplacement où vous avez renommé le dossier de documentation décompressé.

2. Copiez le dossier EN, JA ou FR dans le dossier documentation au sein des fichiers du produit :

   Exemple : C:\Program Files\RPA DesktopAutomation 11.4.0.0\documentation

Pour passer en mode en ligne, supprimez ou déplacez le dossier documentation du dossier RPA DesktopAutomation 11.4.0.0.

Documentation hors ligne de Process Discovery

1. Dans chacun des dossiers suivants, créez un nouveau dossier appelé documentation. Le chemin d'accès réel aux dossiers peut être différent.

   • Exemple : C:\Program Files (x86)\Kofax RPA Process Discovery Agent 11.4.0.0

   • Exemple : C:\Program Files (x86)\Kofax RPA Process Discovery Analyzer 11.4.0.0

2. Accédez à l'emplacement où vous avez renommé le dossier de documentation décompressé.

   Copiez le dossier EN, JA ou FR dans les dossiers documentation nouvellement créés.

Pour passer en mode en ligne, renommez, supprimez ou déplacez le dossier documentation des dossiers Kofax RPA Process Discovery Agent 11.4.0.0 et Kofax RPA Process Discovery Analyzer 11.4.0.0.

Documentation hors ligne des Kapplets

La documentation hors ligne pour Kofax RPA Kapplets est contenue dans le fichier KofaxRPAManagementConsoleDocumentation.war que vous avez déjà copié dans le dossier d'installation de Tomcat. Pour utiliser la documentation Kapplets en mode hors ligne, suivez les étapes ci-dessous.

1. Selon que les Kapplets sont installés en mode intégré, sur Tomcat ou sur Docker, définissez les propriétés requises dans le fichier de configuration correspondant. Pour les informations relatives à chaque scénario d'installation, voir Installer les Kapplets dans le Guide d'installation de Kofax RPA.

   • Mode Intégré. Créez un fichier application-help.properties en utilisant le modèle suivant et placez-le à côté du fichier application.properties dans le dossier à partir duquel les Kapplets sont exécutés.

     kapplets.services.mc.connection.url=http:// <host-url>:<port>/ManagementConsole
     kapplets.services.mc.connection.username=<username>
     kapplets.services.mc.connection.password=<password>
     kapplets.services.help.languages-map[en]=EN
     kapplets.services.help.languages-map[ja]=JA
     kapplets.services.help.languages-map[fr]=FR
     kapplets.services.help.base-url=http://:/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets
     kapplets.services.help.landing-url=http://:/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets/c_rpakappletsmain.html
     

   Dans ce scénario, la documentation hors ligne ne peut être utilisée que si la Management Console est déployée sur Tomcat.

   • Sur Tomcat. Dans le fichier kapplets.xml, ajoutez les propriétés suivantes à la fin du fichier.

     <Environment name="kapplets.services.help.languages-map[en]" value="EN"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.languages-map[ja]" value="JA"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.languages-map[fr]" value="FR"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.base-url" value="http://<hosturl>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets" type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.landing-url" value="http://<hosturl>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets/c_rpakappletsmain.html" type="java.lang.String" override="false"/>
     

   • Sur Docker. Dans le fichier docker-compose.yml, ajoutez les propriétés suivantes à la fin du fichier.

      - KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[en]=EN
      - KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[ja]=JA
      - KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[fr]=FR
      - KAPPLETS_SERVICES_HELP_BASE-URL=http://<host-url>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets
      - KAPPLETS_SERVICES_HELP_LANDING-URL=http://<host-url>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets/c_rpakappletsmain.html
     

2. Enregistrez le fichier. Si des Kapplets sont installés sur Tomcat et que vous avez configuré le fichier kapplets.xml, vous devrez peut-être redémarrer le serveur Tomcat pour que les modifications prennent effet.

Pour passer en mode En ligne, supprimez les propriétés ajoutées du fichier de configuration, enregistrez les modifications et redémarrez le serveur.