Handbookとの連携について
フローデザイナーのパレットで「Handbook」タブにあるコンポーネント群を使用すると、Handbookサーバーに対してさまざまな操作を行うことができます。
この文書では、本製品とHandbookサーバーの連携について説明します。
Handbookとは
Handbookとはインフォテリア社によって提供される企業や団体で利用されるドキュメントやファイルなどの様々な情報をスマートタブレット、スマートフォンに配信し共有できる法人様向けサービスです。
HandbookではWebAPIが提供されており、本製品はWebAPIを利用してHandbookとの連携を実現しています。
詳細については、Handbook製品のWebサイトをご覧ください。
フローサービスとHandbookの連携
フローサービスとHandbookを連携すると、以下のような利用例を実現することができます。
-
Handbookを定期的に自動作成する
スケジューラーから実行したフローでデータベース等にある情報を取得して、Handbookを作成しアップロードを行う -
試験結果を定期的に収集しグラフ化する
スケジューラーから実行したフローでHandbookから試験結果を取得し、グラフコンポーネントを使用してレポートを作成する
Handbook連携の実装方法
前述の利用例のような連携処理を行うするためには、いくつかの事前準備と設定が必要です。
Handbookでの準備
フローサービスでHandbookコンポーネントを使用するためには、最初に対象とするHandbookサーバーでWebAPIを実行するStudioユーザ(管理者権限:オン)を作成する必要があります。Studioユーザの作成方法については「Handbook studio ユーザーガイド」を参照してください。
フローサービスでの準備
フローサービスでは、接続種別が「汎用」のコネクションを作成してHandbookサーバー接続用の設定を行います。コネクション設定では以下のパラメータを定義します。
| パラメータ名 | 設定内容 |
|---|---|
| url |
HandbookサーバーのWebAPIのURLを指定します。 URLは通常「https://<ホスト名>/」です。 |
| user | Handbookサーバーにログインするユーザー名を指定します。 |
| password | Handbookサーバーにログインするユーザーのパスワードを指定します。 |
| useProxy |
FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。 |
※ここで設定するユーザーは実行時にコンポーネントプロパティにユーザー名をマッピングすることによりユーザーを切り替えることもできます。
Handbookコンポーネント
Handbookコンポーネントは全部で15個あります。
| HandbookCreateFromFolder | 指定フォルダからHandbookを作成しアップロード | |
|---|---|---|
| HandbookCreate | Handbook作成 | |
| HandbookDelete | Handbook削除 | |
| HandbookCreateChapter | チャプター作成 | |
| HandbookUpdateChapter | チャプター更新 | |
| HandbookDeleteChapter | チャプター削除 | |
| HandbookCreateSection | セクション作成 | |
| HandbookUpdateSection | セクション更新 | |
| HandbookDeleteSection | セクション削除 | |
| HandbookCreateUser | Handbookユーザー作成 | |
| HandbookUpdateUser | Handbookユーザー更新 | |
| HandbookDeleteUser | Handbookユーザー削除 | |
| HandbookExaminationResult | 試験結果のダウンロード | |
| HandbookQuestionnaireResult | アンケート結果のダウンロード | |
| HandbookUserLog | ユーザー操作記録のダウンロード |
Handbookコンポーネントのコネクション設定
コネクション設定を作成後、フローデザイナーでフローを作成して、Handbookコンポーネントを配置します。コンポーネントの「コネクション名」プロパティで作成したコネクション設定を選択します。
コンポーネントの使用とWebAPI
HandbookのWebAPIはHTTP GET、POSTメソッドで実装されています。そのため、実際には上記コンポーネント群を使用せずに直接任意のHttpClientからAPIを実行することもできます。フローサービスのコンポーネント群はWebAPIをラップしたものでありログイン処理などをカプセル化したものとなっています。WebAPIについての詳細な情報は、Handbookの「Handbook Editors WebAPI」を参照してください。
上記コンポーネント群では、内部的にログイン処理を行っているため、特別な前処理なしにフロー内の任意の場所で実行可能です。