1. Senju Quick Assistant導入にあたって

この章では、Senju Quick Assistantの概要について説明します。

1.1. Senju Quick Assistantとは

1.1.1. Senju Quick Assistantのコンセプト

Senju Quick Assistantは日々の日常業務で蓄積されたナレッジの管理・公開を、簡単・迅速に実現することができるツールです。

適切なナレッジを登録、公開することで、エンドユーザーからの問合せ回数の低減や、サービスデスクユーザーの業務効率の向上が期待できます。 これらナレッジを活用することで、日々の業務プロセスを円滑に進めることが可能となります。

  • WEBベースの容易な導入

    Senju Quick AssistantはOSSを活用したWEBベースのアプリケーションです。クライアントに新たなソフトウェアのインストールが不要のため導入が容易です。また、バージョンアップやメンテナンスの負荷を低減することができます。 システムの要件に応じて、サーバーを拡張することでWEBサーバーを複数構築することもでき、スケーラブルな構築が可能です。

  • 現場担当者志向のインタフェース

    Senju Quick Assistantのインタフェースは、シンプルでかつ統一されたデザインで構成され、サービスデスクのオペレータやエンドユーザーといった現場担当者が直感的かつ容易に操作を行うことができます。 また、スマートデバイスでの利用でも使いやすいレスポンシブUIを活用したインターフェースになっており、出先でのインシデント対応といったような現場担当者が求めるニーズに応えます。

  • 自由なナレッジフォーマット

    Senju Quick AssistantはMakedown形式をベースにしたナレッジ作成・編集機能を提供しており、テキストのみならずが画像や添付ファイルなどもナレッジの一部として公開することが可能です。 また、プレビューを確認しながらナレッジを編集することでエンドユーザーからのナレッジの見え方がリアルタイムで確認することができます。 さらに、ナレッジテンプレートを利用することでナレッジ新規作成時の作業効率化およびナレッジフォーマットの標準化も期待できます。

  • 高速全文検索

    ナレッジの高速全文検索機能を提供しており、検索キーワードを形態素解析したうえで、検索キーワードと類似度の高い検索結果を表示することによって、 エンドユーザーがより早く有用な情報を特定することが可能になります。

  • 他サービスとの有機的な連携

    Senju Quick Assistantは、全機能に対してRestful WEBAPIを提供しているため、Senju Quick Assistant単体での利用のみならず、 ほかのサービスとWEBAPIで連携することで様々なソリューションを実現することができます。

1.1.2. Senju Quick Assistantの機能

Senju Quick Assistantは、用途や利用者の役割に応じて、ビルダおよびナビゲーターで構成されています。 | ビルダはナレッジ作成者向けにナレッジを管理するため機能を提供するのに対し、ナビゲーターはナレッジ参照者向けにナレッジの検索、参照機能を提供します。

  • ビルダ

    サブシステム
    機能
    共通機能
    ・ サインイン
    ・ サインアウト
    ページ
    ・ ページの管理
    カテゴリ
    ・ カテゴリの管理
    トピック
    ・ トピックの管理
    ページテンプレート
    ・ ページテンプレートの管理
    ユーザー
    ・ ユーザーの管理
    グループ
    ・ グループの管理

  • ナビゲーター

    サブシステム
    機能
    参照
    ・ カテゴリ一覧
    ・ トピック一覧
    ・ ページ一覧
    ・ ページ詳細
    検索
    ・ 全文検索
    ・ ラベル検索

1.1.3. Senju Quick Assistantの基本構成

Senju Quick Assistantシステムは、次の4種類のノードによって構成されます。

  1. Senju Quick Assistant WEBサーバー

  2. Senju Quick Assistant アプリケーションサーバー

  3. Senju Quick Assistant DBサーバー

  4. Senju Quick Assistant 全文検索サーバー

_images/systemConfigureExample.png

図 1.1 Senju Quick Assistantの構成例

1.1.4. Senju Quick Assistantのライセンス

  1. Senju Quick Assistantシステムライセンス

    Senju Quick Assistantシステムでは、利用する機能やユーザーの規模に応じて、異なるライセンスが必要となります。ライセンスは通常Senju Quick Assistant初期導入時に設定しますが、利用する機能の追加や利用ユーザーの追加の際には、ライセンスの更新が必要となります。

  2. ライセンスキー

    ライセンスキーは、ご購入いただいたSenju Quick Assistantシステムのライセンス内容に応じて、使用可能な機能やユーザー数が異なります。

  3. ライセンスキーの有効期限

    ライセンスキーには有効期限があり、それを超えるとSenju Quick Assistantシステムが利用できなくなります。

1.2. Senju Quick Assistant導入の前に

1.2.1. 担当者の役割

Senju Quick Assistantシステムの運用には、次の担当者および登場人物を想定しています。

  • システム管理者

  • ナレッジ管理者

  • エンドユーザー

  1. システム管理者の役割
    システム管理者は、業務システム全体を管理し、すべての運用を統括します。

    • 業務システム全体の構成管理

    • ユーザー管理

    • Senju Quick Assistantシステムのメンテナンス

  2. ナレッジ管理者の役割
    ナレッジ管理者は、最新のナレッジの作成、公開および既存ナレッジのメンテナンス作業を担当します。

    • ナレッジの利用状況確認

    • Senju Quick Assistantナレッジのメンテナンス

  3. エンドユーザーの役割
    エンドユーザーは業務システムを実際に使用し、業務を行います。

    • 日常業務の遂行

    • 公開されたナレッジの検索・参照

1.3. Senju Quick Assistantの導入

1.3.1. システムの導入

ここでは、Senju Quick Assistantシステムの導入の流れについて説明します。
導入手順の詳細は、 インストールガイド「1. インストールの概要」 を参照してください。
  1. インストール前の設定確認
    Senju Quick Assistantをインストールする各機器のOS設定を確認します。
    詳細は、インストールガイドを参照してください。
  2. PostgreSQLの導入
    Senju Quick Assistant DBサーバーの稼働に必要なソフトウェアである、PostgreSQLをインストールします。
    詳細は、インストールガイドを参照してください。
  3. Pythonの導入
    Senju Quick Assistant アプリケーションサーバーの稼働に必要な ソフトウェアである、Pythonをインストールします。
    詳細は、インストールガイドを参照してください。
  4. ApacheあるいはNginxの導入
    Senju Quick Assistant WEBサーバーの稼働に必要なソフトウェアである、Apache(Windows利用時)あるいはNginx(Linux利用時)をインストールします。
    詳細は、インストールガイドを参照してください。
  5. Senju/QA アプリケーションサーバーのインストール
    Senju Quick Assistant アプリケーションサーバーに、Senju Quick Assistantのパッケージをインストールします。
    詳細は、インストールガイドを参照してください。
  6. ElasticsearchおよびLogstashの導入
    Senju Quick Assistant 全文検索サーバーに、ElasticsearchおよびLogstashをインストールします。
    詳細は、インストールガイドを参照してください。

1.3.2. システムのディレクトリ構成

Senju Quick Assistantを導入した後のディレクトリ構成は下記のようになっています。

注釈

各サーバーのインストールディレクトリはインストールガイドに記載しているデフォルトディレクトリです。

Windows

  • Senju/QA アプリケーションサーバー

    📂c:
    ┗ 📂senjuqa
    ┣ 📂config
    ┃ ┣ 📜__init__.py
    ┃ ┣ 📜asgi.py
    ┃ ┣ 📜settings.py
    ┃ ┣ 📜urls.py
    ┃ ┗ 📜wsgi.py
    ┣ 📜.env
    ┣ 📜manage.py
    ┣ 📜senjuqa-uwsgi.ini
    ┗ 📜senjuqa.sock

  • Senju/QA DBサーバー

    📂c:
    ┗ 📂Program Files
    ┗ 📂PostgreSQL
    ┗ 📂13
    ┗ 📂data

  • Senju/QA 全文検索サーバー

    📂c:
    ┣ 📂elasticsearch
    ┗ 📂logstash

  • Senju/QA WEBサーバー

    📂c:
    ┗ 📂Apache24

Linux

  • Senju/QA アプリケーションサーバー

    📂/
    ┗ 📂opt
    ┗ 📂senjuqa
    ┣ 📂config
    ┃ ┣ 📜__init__.py
    ┃ ┣ 📜asgi.py
    ┃ ┣ 📜settings.py
    ┃ ┣ 📜urls.py
    ┃ ┗ 📜wsgi.py
    ┣ 📜.env
    ┣ 📜manage.py
    ┣ 📜senjuqa-uwsgi.ini
    ┗ 📜senjuqa.sock

  • Senju/QA DBサーバー

    📂/
    ┗ 📂opt
    ┗ 📂postgres
    ┗ 📂data

  • Senju/QA 全文検索サーバー

    📂/
    ┣ 📂etc
    ┃ ┣ 📂elasticsearch
    ┃ ┗ 📂logstash
    ┗ 📂opt
    ┗ 📂logstash

  • Senju/QA WEBサーバー

    📂/
    ┗ 📂etc
    ┗ nignx