今週のテクニカルTips : Just Ask Innovator ヘルプのカスタマイズ方法

Aras Innovatorに備わっているWebヘルプシステムは、お客様のニーズに合わせたカスタムヘルプが提供できるよう、適切なツールを用いて拡張することができます。オリジナルのヘルプドキュメントの内容は、リリース毎に更新されており、ヘルプファイルに加えた変更を守る容易な方法は存在しないため、変更しないことをお勧めします。

要件

Just Ask Innovator ヘルプシステムはAdobe RoboHelpツールキットを使用して作成されています。新しいヘルプファイルを作成したりJust Ask InnovatorのTOCにリンクを追加したりするためには、このソフトウェアにアクセスする必要があります。

この記事で紹介する例を実践するにはAdobe RoboHelpとmarged projectsのコンセプトについての知識が必要になります。この例で使用しているAdobe RoboHelpのバージョンは10ですが、以前のバージョンでもサポートされます。

設定変更を行うためには、Aras Innovator管理者権限が必要です。

また、Just Ask Innovatorヘルプシステムを再作成するために使用される Adobe RoboHelpのソースファイルを入手するためには、現在Arasのサブスクライバーである必要があります。ソースファイルの入手についてはArasサポートにご連絡ください。

ドキュメントゴールの特定

カスタムドキュメンテーションを書き始める前に、達成したいゴールを特定しておくことが重要です。

  1. まず、ターゲットと彼らが求める情報を特定します。完全に異なる種類のドキュメントを求める複数のユーザーグループが存在する場合もあります。例えば、ビジネスオブジェクトの設定方法やメソッドやアクションのカスタマイズ方法、グリッドの設定方法を知る必要のある管理者グループが存在します。一方で、特定のフォームを正確に埋める方法やIn Baskets内のアイテムへの対応方法について知りたがっているユーザーグループも存在します。
  2. 各情報セットに対し、どのInnovator書類が必要/不要なのかを決定します。
  3. 各情報セットに対し、どのようなカスタムドキュメントを新たに作成すべきかを決め、それらのアウトラインと流れを決定します。
  4. 特定のページを参照させるべきアイテムタイプを確認します。例えばAras Innovator内のヘルプURLショートカットから直接特定のページに飛ぶようにすることも可能です。

 

Innovator ヘルプソースファイル

InnovatorヘルプのソースファイルはSolutionsCoreProject.zipという名前のファイルに含まれています。現在サブスクリプション契約をお持ちの方は、Arasサポートにご連絡いただければ当ファイルを入手可能です。

ソースファイルを作業場所に展開し、InnovatorヘルプのTOCと関連したファイル構造になっているか確認してください。

pic1

Innovatorヘルプシステムは、Solutions/InnovatorSolutions ディレクトリ下のマスタープロジェクトに統合された、Adobe RoboHelpサブプロジェクトの集合対が基となっています。サブプロジェクトフォルダーには以下が含まれています。

  • Just Ask Innovator (TOCで表示されるInnovator管理book及びクライアントユーザーインターフェースbook)
  • ProductEngineering (プロダクトエンジニアリングbook)
  • QualityPlanning (品質計画book)
  • ProgramManagement (プログラムマネジメントbook)
  • ToolsProject (ツールbook)

 

Innovatorの標準TOCにbook及びトピックの追加(又は削除)を行うには、上記で述べたSolutions/InnovatorSolutionsディレクトリ下にあるInnovatorSolutions.xpjという名前のAdobe RoboHelpマスタープロジェクトにアクセスする必要があります。

InnovatorSolutionsマスタープロジェクトの修正

1. Adobe RoboHelpを使い、Solutions/InnovatorSolutionsディレクトリ下にあるInnovatorSolutions.xpjという名前のプロジェクトファイルを開きます。使用しているAdobe RoboHelpのバージョンによってはプロジェクトの更新を行う必要があります。

pic2

2. プロジェクトのTOCにアクセスし、デフォルトのInnovatorSolutions TOCを表示します。

pic3

3 .前述のように、InnovatorSolutionsプロジェクトにはMerged Projectsの集合体が含まれています。Aras Innovatorの将来リリースで更新される可能性があるため、サブプロジェクトの内容は修正しないよう、強く推奨いたします。

4. カスタムサブプロジェクトを参照する新規Bookを追加するには、TOC Add bookアクションを使用します。

pic4

5. この例では、CMMSという名前のお客様アプリケーションについて説明する新しいbookを追加し、リストの最後に置いています。

pic5

6. このbookに新しいMerged Projectが追加されました。このbookから、これから作成するカスタムサブプロジェクトを参照するようにします。

pic6

7. カスタマイズされたTOCのトップレベルに、ウェルカムページが追加されました。

pic7

8. 最後に、当プロジェクトがWebHelpプロジェクトとしてステージングフォルダーに公開されました。この例におけるステージングフォルダー名はArasSolutionPublishです。

pic8

pic9

9. プロジェクトが公開されると、マスタープロジェクト内で設定されたMerged Projects用に、Adobe RoboHelpがディレクトリ構造をプレースホルダーと共に作成します。各プレースホルダーフォルダーには、次のセクションで説明する公開済みサブプロジェクトが含まれるようになります。

pic10

サブプロジェクトの公開

Adobe RoboHelp を使用してInnovatorヘルプテーブルに含めたいサブプロジェクトソースを開き、WebHelpプロジェクトを上記の各フォルダーに公開します。最終プロジェクトで使用できるのは、公開されたサブプロジェクトのみです。

1. 例えば、Product Engineeringプロジェクトを含めたい場合は、そのソースプロジェクトを開きます。

pic11

2. mergedProjects下にある、作業ステージングディレクトリに公開します。

pic12

3. 対象のサブアプリケーション全てに対し、同様のプロセスを行います。

この例の場合:

オープンソースサブプロジェクト ステージングディレクトリへの公開済
InnovatorHelp/InnovatorSolutions/Innovator/
Just Ask Innovator/Just Ask Innovator.xpj
ArasSolutionPublish/WebHelp/mergedProjects/
Just Ask Innovator
InnovatorHelp/InnovatorSolutions/Project/
ProgramManagement/ProgramManagement.xpj
ArasSolutionPublish/WebHelp/mergedProjects/
ProgramManagement
InnovatorHelp/InnovatorSolutions/QP/
QualityPlanning/QualityPlanning.xpj
ArasSolutionPublish/WebHelp/mergedProjects/
QualityPlanning

 

カスタムサブプロジェクトの作成

上記の修正されたInnvovatorSolutionsプロジェクトに対し、CMMSと呼ばれる新しいMerged Projectも作成できます。Adobe RoboHelpを使用して、新規プロジェクトとお好きなbook/トピックを作成してみましょう。Adobe RoboHelpを使用したヘルププロジェクトの作成方法詳細については、こちらを参照ください。

1. この例では、新規プロジェクトにCMMSという名前をつけます。

pic13

2. (オプション) Solutions/InnovatorSolutions ソースファイルから、basic page.httと呼ばれるInnovatorマスターページを新プロジェクトにインポートする事で、既存のInnovatorヘルプページと同様の形式を維持する事も可能です。マスターページの詳細についてはこちらを参照ください。

3. この例では、新しいbookに2つのトピックページを持つCMMSプロジェクトを作成しました。

pic14

4. CMMSプロジェクトを、前述のmergedProjects/CMMSステージングフォルダーに公開します。

pic15

テスト結果

公開ファイルをAras Innovatorサーバーに複製する前に、プロジェクトが正しく表示、動作するかをテストして確かめましょう。

ブラウザーを使い、ArasSolutionPublish/WebHelp/ ステージングフォルダーにあるJust_Ask_Innovator.htmファイルを開きます。

pic16

bookとトピックリンクの挙動が正しいことを確認します。Bookが見当たらない時は、多くの場合正しいmergedProjectsフォルダーにサブプロジェクトを公開していないことが原因です。

Aras Innovatorサーバーにファイルをコピー

Aras Innovatorサーバーでは、公開ヘルプファイルが以下のフォルダー構造で保持されます。

[installation folder]/Innovator/Client/WebHelp/[languagecode]

この例での言語コードは英語のため、”en”となります。

  1. “en” フォルダー及びサブフォルダーのバックアップを取得
  2. 公開されたステージングディレクトリから、WebHelp ステージングフォルダーの内容を全てコピーします。この例では、このディレクトリ配下の全ファイル及びフォルダーです:
    ArasSolutionPublish/WebHelp
  3. Aras Serber導入フォルダー”en”に、公開ファイルをペーストします。この例では以下のフォルダーです:
    [installation folder]/Innovator/Client/WebHelp/en
  4. ポップアップで促されたら全てのファイルを置き換えます。但し、現行サーバーディレクトリのファイルを削除しないように注意してください。Aras Innovatorクライアントからヘルプファイルを使用するには、このヘルプソースに含まれていないいくつかのファイルが必要となります。
  5. 全てのファイルのコピーに成功したら、Aras InnovatorメインメニューからHelp -> Just Ask Innovator を選択することで、全てのユーザーがこの修正されたヘルプシステムを使用できるようになります。

pic17

まとめ

今回は、Just Ask Innovatorヘルプシステムのカスタマイズ方法をご紹介しました。Aras Innovatorのバージョンアップを実施した際には、このヘルプシステムも最新になるよう、このプロセスをレビューしてください。

Aras PLMの詳細・ダウンロードはこちらから
Aras_Logo_2013