製品のドキュメント

Kofax RPA のドキュメント セットには次の場所からアクセスできます。1

https://docshield.kofax.com/Portal/Products/RPA/11.2.0_ea1ydbmwk9/RPA.htm

また、Kofax RPA から個々のガイドやオンライン ヘルプに直接アクセスすることもできます。Design Studio、Management Console、Desktop Automation サービスと Process Discovery でヘルプ ボタンをクリックすると、オンライン ドキュメントが新しいブラウザ ウィンドウに表示されます。

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

オフライン ドキュメント

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

  • KofaxRPADocumentation-11.2.0_EN.zip

    すべての Kofax RPA のドキュメントが英語で含まれています。

  • KofaxRPADocumentation-11.2.0_JA.zip

    すべての Kofax RPA のドキュメントが日本語で含まれています。

  • KofaxRPADocumentation-11.2.0_FR.zip

    すべての Kofax RPA のドキュメントがフランス語で含まれています。

Kofax RPA 製品をインストールした後、必要な言語のドキュメント .zip ファイルの内容を抽出します。各言語の .zip ファイルには、次のフォルダが含まれています。

  • API:
  • ベスト プラクティス

  • Design Studio
  • Desktop Automation サービス
  • Management Console
  • Process Discovery

ファイルを抽出した後、Design Studio 用のドキュメント フォルダ、Desktop Automation サービス、および Process Discovery は次の構造になります。

  • ENJA、または FR (それぞれ英語、日本語、またはフランス語)
    • print と/または help (各 PDF ドキュメントと Kofax RPA のヘルプそれぞれ)

Management Console にはドキュメントや言語コードのフォルダはなく、ManagementConsoleHelp.war ファイルのみが Management Console プログラム ファイルに追加されます。

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

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

API フォルダには、英語の API リファレンスが含まれています。

  1. 上記で抽出した英語の .zip ファイルから API フォルダをコンピュータ上の任意のフォルダにコピーします。

  2. このフォルダで、Overview.html をダブルクリックして API ドキュメントを開きます。

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

  1. 上記で抽出した英語の .zip ファイルの Design Studio フォルダを開き、EN フォルダを次のフォルダにコピーします。

    C:\Program Files\Kofax RPA 11.2.0.0\documentation

  2. 日本語またはフランス語のドキュメントが必要な場合は、上記で抽出した日本語またはフランス語の .zip ファイルから Design Studio フォルダを開き、JA/FR フォルダを同じ場所にコピーします。

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

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

  5. 変更を保存します。

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

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

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

  1. 上記で抽出した英語の .zip ファイルから Management Console フォルダを開き、ManagementConsoleHelp.war ファイルを次の場所にコピーします。

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

    英語、日本語、およびフランス語の .zip ファイルには、英語、日本語、およびフランス語のドキュメントを含む同じ .war ファイルがそれぞれ含まれています。英語の .zip ファイルから .war ファイルをコピーしていて、日本語版またはフランス語版のドキュメントが必要な場合、それ以上のアクションは不要です。
  2. Management Console を開始。

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

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

    : http://localhost:8080/ManagementConsoleHelp/

  5. 変更を保存します。

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

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

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

  1. 次の場所にあるフォルダ documentation に移動します。

    C:\Program Files\RPA DesktopAutomation 11.2.0.0

  2. 上記で抽出した英語の .zip ファイルの Desktop Automation Service フォルダを開き、EN フォルダを documentation フォルダにコピーします。

  3. 日本語またはフランス語のドキュメントが必要な場合は、上記で抽出した日本語またはフランス語の .zip ファイルから Desktop Automation Service フォルダを開き、JA/FR フォルダを同じ場所にコピーします。

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

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

  1. 次の各フォルダで、documentation という名前の新しいフォルダを作成します。

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

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

  2. 上記で抽出した英語の .zip ファイルの Process Discovery フォルダを開き、EN フォルダを documentation フォルダにコピーします。

  3. 日本語またはフランス語のドキュメントが必要な場合は、上記で抽出した日本語またはフランス語の .zip ファイルから Process Discovery フォルダを開き、JA/FR フォルダを同じ場所にコピーします。

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

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

Kofax RPA Kapplets のオフライン ドキュメントは Management Console のように、同じ .war ファイルに含まれています。これは、すでに English.zip ファイルからコンピュータ上の必要な場所 (Tomcat インストール フォルダ) にコピーされています。オフライン モードで Kapplets ドキュメントを使用するには、次のステップを実行します。

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

    • 組み込みモード。次のテンプレートを使用して 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://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets
      kapplets.services.help.landing-url=http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/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://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets"   type="java.lang.String" override="false"/>
      <Environment name="kapplets.services.help.landing-url" value="http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/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>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets
       - KAPPLETS_SERVICES_HELP_LANDING-URL=http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets/c_rpakappletsmain.html
      

  2. ファイルを保存します。変更を有効にするには、Tomcat サーバーの再起動が必要になる場合があります。

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

1 オンラインのドキュメント セットにアクセスするにはインターネットに接続する必要があります。