製品のドキュメント

Kofax RPA のドキュメント セットは、次の場所で入手できます。

https://docshield.kofax.com/Portal/Products/RPA/11.4.0-vcsft2fhaw/RPA.htm

Kofax RPA から直接オンライン ヘルプにアクセスできます。Design Studio、Management Console、Desktop Automation サービス、Process Discovery、およびKapplets のヘルプ ボタンをクリックして、オンライン ドキュメントを新しいブラウザ ウィンドウで表示します。

組織のセキュリティ ポリシーでインターネット アクセスが制限されている場合、またはインターネット接続が安定していない場合は、製品の使用中にオフライン モードでドキュメントにアクセスできます。

オフライン ドキュメント

ドキュメントをオフライン モードで使用できるようにするには、Kofax フルフィルメント サイトからダウンロードした Kofax RPA 製品パッケージのドキュメント ファイルを入手します。

製品パッケージには、オフラインで使用するための次のドキュメント ファイルが含まれています。

  • KofaxRPADocumentation_11.4.0_EN.zip

    英語の Kofax RPA ドキュメントの全セットが含まれています。

  • KofaxRPADocumentation_11.4.0_JA.zip

    Java API ドキュメントを除く、日本語の Kofax RPA ドキュメントの全セットが含まれています。

  • KofaxRPADocumentation_11.4.0_FR.zip

    Java API ドキュメントを除く、フランス語の Kofax RPA ドキュメントの全セットが含まれています。

  • KofaxRPAManagementConsoleDocumentation-11.4.0.zip

    Management Console と Kapplets の英語、日本語、およびフランス語のドキュメントが含まれています。

Kofax RPA 製品をインストールしたら、次の手順に従います。

  1. 必要な言語の KofaxRPADocumentation.zip ファイルの内容をコンピュータ上の場所に抽出します。

    次に、.zip ファイルの名前に付いている言語コードに応じて、抽出したフォルダの名前を ENJA、または FR のいずれかに変更します。たとえば、KofaxRPADocumentation_11.4.0_EN の場合は、名前を EN に変更する必要があります。

    各言語の抽出済みフォルダには、次のフォルダが含まれています。

    • api
    • help
    • print
    • Resources

  2. KofaxRPAManagementConsoleDocumentation.zip ファイルの内容をコンピュータ上の場所に抽出します。

    抽出したフォルダの名前を変更する必要はありません。

    抽出したフォルダには、3 つの言語すべてのドキュメントを含む KofaxRPAManagementConsoleDocumentation.war ファイルが含まれています。

以下の手順に従って RPA コンポーネントのオフラインドキュメントがインストールされると、アクティブなインターネット接続が存在する場合でも、コンポーネントはデフォルトでドキュメントのオフライン バージョンを使用します。

オフライン API ドキュメント

いずれかの KofaxRPADocumentation ZIP ファイルから抽出したフォルダには、英語の API リファレンスが含まれています。このフォルダから、RoboSuite Java および RoboSuite .NET API のドキュメントにアクセスできます。

Design Studio のオフライン ドキュメント

  1. 抽出して名前を変更したドキュメント フォルダが含まれている場所に移動します。

  2. ENJA、または FR フォルダを製品ファイル内の documentation フォルダにコピーします。

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

  3. Design Studio を開始し、[設定] > [Design Studio 設定] へ移動します。

  4. [一般] タブの [ドキュメントの場所] でリストの [オフライン] を選択します。

  5. 変更を保存します。

オンライン モードに切り替えるには、[Design Studio 設定] の [オンライン] を選択し、変更を保存します。

インターネットにアクセスせずに Kofax RPA からオンライン ドキュメントにアクセスしようとすると、[ヘルプとドキュメントを取得] という警告が表示されます。[今後この通知を表示しない] を選択し、後でこのオプションをリセットする場合は、[Design Studio 設定] にある [一般] タブで [ドキュメントの取得通知を表示] を選択します。

Management Console のオフライン ドキュメント

  1. 抽出した KofaxRPAManagementConsoleDocumentation.war ファイルが含まれている場所に移動します。

    .war ファイルには、3 つの言語すべてのドキュメントが含まれています。使用するドキュメントは、Management Console の設定言語によって異なります。

  2. ファイルを次の場所にコピーします。

    C:\[Tomcat インストール フォルダ]\Tomcat [バージョン]\webapps

  3. Management Console を開始。

  4. [設定] > [一般] > [ベース URL] を開きます。

  5. [ローカルのドキュメントを使用] を選択します。[ローカル ドキュメント ベース URL] で、ドキュメントが含まれている Tomcat Web サイトの URL を指定します。

    : http://localhost:8080/KofaxRPAManagementConsoleDocumentation

  6. 変更を保存します。

変更を有効にするために Management Console の更新が必要になることがあります。

オンライン モードに切り替えるには、ベース URL 設定の [ローカルのドキュメントを使用] をオフにして変更を保存します。

Desktop Automation サービスのオフライン ドキュメント

  1. 抽出して名前を変更したドキュメント フォルダが含まれている場所に移動します。

  2. ENJA、または FR フォルダを製品ファイル内の documentation フォルダにコピーします。

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

オンライン モードに切り替えるには、RPA DesktopAutomation 11.4.0.0 フォルダから documentation フォルダを削除するか、移動します。

Process Discovery のオフライン ドキュメント

  1. 各インストール フォルダで、documentation という名前の新しいフォルダを作成します。フォルダへの実際のパスは異なる場合があります。

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

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

  2. 抽出して名前を変更したドキュメント フォルダが含まれている場所に移動します。

    ENJA、または FR フォルダを新しく作成した documentation フォルダにコピーします。

オンライン モードに切り替えるには、Kofax RPA Process Discovery Agent 11.4.0.0Kofax RPA Process Discovery Analyzer 11.4.0.0 フォルダから documentation フォルダの名前の変更、削除、または移動をします。

Kapplets のオフライン ドキュメント

Kofax RPA Kapplets のオフライン ドキュメントは、Tomcat インストール フォルダにコピーした KofaxRPAManagementConsoleDocumentation.war ファイルに含まれています。オフライン モードで Kapplets ドキュメントを使用するには、次のステップを実行します。

  1. Kapplets が組み込みモードでインストールされている場合や Tomcat にインストールされている場合、あるいは Docker にインストールされている場合といった状況に応じて、それぞれの設定ファイルに必要なプロパティを設定します。各インストール シナリオの詳細については、『Kofax RPA インストール ガイド』の「Kapplet をインストールする」を参照してください。

    • 組み込みモード。次のテンプレートを使用して application-help.properties ファイルを作成し、Kapplets が実行されているフォルダ内の application.properties ファイルの横に配置します。

      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
      

    このシナリオでは、Management Console が Tomcat にデプロイされている場合にのみ、オフライン ドキュメントを使用できます。

    • Tomcat でのインストール: Kapplets.xml ファイルに、ファイルの最後に次のプロパティを追加します。

      <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"/>
      

    • Docker でのインストール: docker-compose.yml ファイルの最後に次のプロパティを追加します。

       - 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. ファイルを保存します。Kapplets が Tomcat にインストールされていて、kapplets.xml ファイルを調整した場合、変更を有効にするには、Tomcat サーバーの再起動が必要になる場合があります。

オンライン モードに切り替えるには、設定ファイルから追加されたプロパティを削除し、変更を保存してサーバーを再起動します。