メインコンテンツへ移動

アプリケーションプラットフォームコア

1. 概要​

1.1 はじめに​

HAPアプリケーションプラットフォームコアは、HAPの機能をパートナーに完全提供することで、顧客やパートナーが指定されたコンピューティングプラットフォーム上にHAPサーバーを導入・実装し、マルチテナント運用を同時に実現できます。言い換えると、顧客やパートナーはパブリッククラウドサービス提供が可能なAPaaS製品の全機能セットを保有することになり、パートナーはOEMで自社垂直サービスと組み合わせて独立運用したり、自社製品への統合をしてエンドユーザーに提供することが可能です。

1.2 用語​

用語説明
認可プラットフォーム関連機能を組織に対して有効化すること。
認可指標プラットフォームで個別販売可能な機能項目、機能セット、または測定可能な機能項目。認可指標はHAPシステムより提供され、ブランドによる追加・削除・変更はできません。
エディションHAPアプリケーションプラットフォームコア自体は完全な製品であり、パートナーはプラットフォームが提供する認可指標項目の組み合わせで、独自に製品版(エディション)を定義できます。初期化時に標準版・プロフェッショナル版・フラッグシップ版の3種類が標準提供されます。ブランドはエディションの編集・追加が可能ですが、削除はできません。
追加購入指標販売・運用担当者が登録済み組織へ認可を付与する際、既存エディションで要件を満たせない場合に、認可指標の追加購入を可能とする拡張指標です。

2. プラットフォームアーキテクチャ​

2.1 製品アーキテクチャ​

  • システム設定:プラットフォームの基本設定と認可情報。導入後、「システム設定」内の「認可」でプラットフォームシークレットキーを入力して認可を行い、その後その他設定項目で初期化を完了します。 (詳細は下記「3.1 プラットフォーム管理」に記載)
  • マスターデータ:組織、認可指標、エディション、プラットフォームユーザーなどの基礎データサービス。
  • APaaS運用:プラットフォーム機能を利用し自社構築した初期アプリケーション。ブランドの営業・運用担当者がこのアプリケーションで組織の認可・管理を行えます。

2.2 デプロイメントアーキテクチャ​

HAPアプリケーションプラットフォームコアは、HAPサーバーのプロフェッショナルクラスタデプロイメント方式を採用し、Kubernetesを用いたサービスオーケストレーションとインスタンス動的スケーリングによりシステム性能を確保しつつ、サーバーリソースを効率的に活用します。下記がデプロイメント構成図です:

最小サーバー構成(同時接続300、可用性99%):

用途構成OS導入サービス台数
ロード/フォワード・マイクロサービスアプリ帯域: 100Mbps
8C/32G/40Gシステムディスク/100Gデータディスク
Debian 10+Nginx,HAPマイクロサービス3
キャッシュ帯域: 100Mbps
4C/16G/40Gシステムディスク/100Gデータディスク
Debian 10+Redis1
ミドルウェア帯域: 100Mbps
4C/16G/40Gシステムディスク/200Gデータディスク
Debian 10+Kafka,Elasticsearch,mingdaoyun-file3
データベース帯域: 100Mbps
8C/32G/40Gシステムディスク/200Gデータディスク(SSD)
Debian 10+MySQL,MongoDB3
ロードイコライザークラウドサービス-プラットフォームアクセスポータル1
オブジェクトストレージクラウドサービス
ストレージパッケージ:1TB
-例:Alibaba Cloud OSS1

推奨サーバー構成(同時接続1000超、可用性99.9%):

用途構成OS導入サービス台数
ロード/フォワード帯域: 100Mbps
4C/8G/100Gシステムディスク/200Gデータディスク
Debian 10+Nginx2
マイクロサービスアプリ帯域: 100Mbps
32C/64G/100Gシステムディスク/300Gデータディスク
Debian 10+HAPマイクロサービス3
キャッシュ帯域: 100Mbps
16C/32G/100Gシステムディスク/200Gデータディスク
Debian 10+Redis2
メッセージキュー帯域: 100Mbps
16C/32G/100Gシステムディスク/500Gデータディスク
Debian 10+Kafka3
全文検索帯域: 100Mbps
16C/32G/100Gシステムディスク/500Gデータディスク
Debian 10+Elasticsearch3
ファイルストレージロードバランス帯域: 100Mbps
16C/32G/100Gシステムディスク/500Gデータディスク
Debian 10+mingdaoyun-file3
RDB帯域: 100Mbps
16C/32G/100Gシステムディスク/500Gデータディスク(SSD)
Debian 10+MySQL2
NoSQL帯域: 100Mbps
32C/64G/100Gシステムディスク/500Gデータディスク(SSD)
Debian 10+MongoDB3
ロードイコライザークラウドサービス-プラットフォームアクセスポータル1
オブジェクトストレージクラウドサービス
ストレージパッケージ:1TB
-例:Alibaba Cloud OSS1

3. プラットフォーム機能概要​

3.1 プラットフォーム管理​

プラットフォーム管理は、プラットフォームの基本設定および認可管理を担当する機能モジュールです。 一般・アプリケーション・ログイン・リソース・コラボレーションスイート・連携・セキュリティ・管理・ログ・ブランド・認可などの設定と管理項目を提供します。 ※個別の管理項目については[プラットフォーム管理]の説明を参照してください。

3.1.1 管理者​

上記の通り、[管理者]モジュールは[プラットフォーム管理]ページの閲覧/管理権限を持つ担当者を設定します。追加できるのは、現在ユーザーが所属する組織の担当者のみです。初期管理者は、プラットフォームインストール登録時の初期ユーザーとなります。(管理者を増やしすぎると操作ミスの懸念があるため推奨しません。異動・退職時は本モジュールで管理権限の引継ぎが可能です。)

3.1.2 ブランド​

上記の通り、HAPパートナーは[ブランド]モジュールでプラットフォームのブランド情報を設定できます。この情報は[ログイン/サインアップ]画面に反映されます。ブランド名、ロゴ、背景画像などを設定可能です。

3.1.3 認可​

上記の通り、プラットフォームのエディション導入後、まず「認可キー」(HAP営業担当より申請)を入力します。認可成功後、[認可]ページで認可情報が表示されます。キーの期限切れや認可アップグレードが必要な場合は、再度キー申請が必要です。

「キー更新」ボタンをクリックし、最新の認可キーを入力して認可完了後、プラットフォームの最新認可が即時反映されます。

認可情報の説明:

認可項目説明
キー有効期限プラットフォーム上でのキー有効期限
アップグレードサービス有効期限プラットフォームが提供するアップグレードサービスの有効期限
内部ユーザー枠プラットフォーム全組織における有効メンバーアカウントの枠数
外部ユーザー枠プラットフォーム全組織における有効外部ユーザーの枠数

3.1.4 組織・ユーザーイベント通知​

上記の通り、プラットフォーム内の組織・ユーザー関連のイベントを設定アドレスへプッシュ通知できます。 組織の新規作成、組織名変更、新規ユーザー登録、ユーザーアカウントの削除、組織への参加・離脱等の操作時に通知が送信されます。

パラメータ説明:

パラメータ名型説明
typeintイベントタイプ:100番台=組織関連、200番台=ユーザー関連
100:組織新規作成
101:組織情報変更
102:新規ユーザー登録
201:ユーザー情報変更(管理者役職変更、ユーザー情報変更、組織参加、再アカウント化含む)
202:ユーザー退職
accountIdstringアカウントID
projectIdstring組織ID
extraDatasstring組織新規作成時の追加情報(JSON形式文字列)、新規作成時のみ値あり
ipstring操作元IP
sourcestring登録トラッキングコード(登録チャネル区別用)
timedatetime操作日時

イベントフォーマット例:

{
"type": 1,
"accountId": "string",
"projectId": "string",
"extraDatas": "string",
"ip": "string",
"source": "string",
"time": "2024-01-01 00:00:00"
}

3.2 APaaS運用​

APaaS運用は、HAPプラットフォーム導入・展開後、パートナーの営業・運用担当者向けに標準提供されるアプリケーションです。パートナーは「APaaS運用」アプリからエディションのカスタマイズ、ユーザーへの「認可ワークオーダ」機能による認可付与、各種機能の有効化ができます。

3.2.1 業務フロー図​

上記の通り、「APaaS運用」アプリケーションは標準的なプラットフォーム運用管理システムを提供します。プラットフォームユーザーはサインアップ後(登録時にデフォルト組織が作成され、これは無料版となりHAP公式無料版と同様の機能となります)、パートナー営業担当が「認可ワークオーダ」モジュールでユーザー認可申請を行います。申請後、運用担当の承認プロセスを経て認可が完了します。

3.2.2 アプリケーション機能説明​

3.2.2.1 アプリケーションデータ初期化​

プラットフォーム導入・展開後、「APaaS運用」アプリケーション初回利用時には次の初期化手順が必要です。

1. マスターデータサービス連携APIの設定

上記の通り、[管理]からアプリケーションの[API]ワークシートにて2つのレコードの「アドレス」フィールドを修正します。

A: CRMサービス(マスターデータサービス)のドメイン名の設定
B: サービス用トークンの設定

※本情報は導入担当者から入手してください(HAPチームが導入した場合は、初期化時に設定済みです)。

2. 認可指標・エディション・組織情報の同期

上記情報の同期時には順序に従って操作してください。同期方法は2つです:

A: アプリケーションの[管理]-[同期データ]ページで左側の同期ボタンを順にクリック

B: ワークフローで手動同期

手順に従ってワークフロー詳細画面右上の「今すぐ実行」ボタンをクリックしてください。

3. アプリケーションロール「営業」「運用」へのメンバー追加

データ同期が完了後、運用ロールのメンバーを初期化します。パートナーは自社メンバーにプラットフォームアカウントの登録招待を行い、プラットフォーム組織に追加した上で「APaaS運用」アプリ内の適切なロールに追加できます。

3.2.2.2 組織管理​

組織管理ではプラットフォーム上すべての組織情報(基本・認可情報含む)を閲覧できます。
組織情報はワークフローで「組織」ワークシートに同期され、タイミング関連情報もあるため、即時反映ではありません。組織詳細ページの「同期データ」ボタンで最新情報を同期できます。(速やかな同期を推奨します)

2. 組織の無効化

この操作は慎重に行ってください。主な影響は次の通りです:

A: 無効化組織の「購入済エディション」が無料版に変更される
B: 無効化組織内の「追加購入指標」すべてが「無効」ステータスになる

3. 認可のキャンセル

認可キャンセルは「組織追加購入指標」の認可を無効化します(キャンセル後は追加購入指標が無効)。認可ミスなどの場合に使用します。

3.2.2.3 製品管理​

製品管理では、認可指標・エディションが含まれます。 認可指標はHAPプラットフォーム提供の基礎機能項目・機能集合であり、認可指標情報は追加・編集・削除不可です(新規項目は定時ワークフロー「[認可指標]データ同期」で運用担当者が同期)。
エディションは各パートナーが[エディション]モジュールで定義します(エディションは認可指標のセット)。エディション情報は編集可能(認可指標の追加・削除・変更含む)ですが、削除不可。初期化時には「標準版」「プロフェッショナル版」「最上位版」の3種類をデフォルト提供します。

3.2.2.3.1 エディション​

1. エディション一覧

2. 新規エディション作成

エディションワークシートのフィールド説明:

フィールド説明
エディションコードエディションの一意識別子。作成後は変更不可。
カテゴリーパートナーが自由に定義可能な予備フィールド。特定顧客向けエディションを区別する場合は「特注製品」などでタグ付け可能。
ステータス「廃止」ステータスのエディションは認可ワークオーダで選択不可。
デフォルトエディションデフォルトエディションは1つのみ。組織作成時のデフォルトお試し版となり、試用期間は編集可能。
認可指標→利用上限エディション内認可指標が「計数」タイプの場合は運用担当が利用上限を設定可能。整数値(1以上)または「無制限」を入力、他の入力は無効(「無制限」は使用量制限なしを意味します)。
3.2.2.3.2 認可指標​

認可指標ワークシートでは、全フィールドが読み取り専用ですが「ステータス」フィールドのみ編集可能です。プラットフォームアップグレード時(認可指標追加時)は手動同期([同期データ]ワークシートで「認可指標同期」ボタンを押下)もしくは定時ワークフロー「[認可指標]データ同期」で自動同期。

認可指標ワークシートのフィールド説明:

フィールド説明
指標コード読み取り専用フィールド
課金区分認可指標が「計数」タイプか区別するのに使用
ステータスエディション定義時、無効ステータスの指標は選択不可
カテゴリーHAPが標準提供するカテゴリ(基礎機能・高度・連携・付加価値サービス)。「連携」は外部サービス連携に該当。「付加価値サービス」は測定用指標。
3.2.2.4 認可管理​

認可管理は「認可ワークオーダ」承認後に組織へ機能認可を行う方法です。認可タイプは以下の通りです:

A: 新規購入
初めて購入する顧客(組織)

B: 更新
有効期限切れ組織がサービス継続する場合(バージョン変更や指標追加購入も可能)

C: 追加購入
購入済み製品・サービスに対し、追加で認可指標を購入(承認後、指標が増加)。

D: アップグレード
主に製品バージョンアップ(指標追加購入も可能)。

E: チャージ
組織のバランス補充(SMS消費やプラットフォームサービス購入等)

認可ワークオーダワークシートのフィールド説明:

フィールド説明
承認ステータスデフォルトは「下書き」「承認済み」「承認失敗」(ユーザー作成時は「下書き」)。作成後はワークフローで運用担当へ通知、承認後はステータス更新。
認可ステータスデフォルトは「正常」。承認完了後でも認可ステータスが異常の場合は「認可異常説明」フィールドで理由を確認。不具合時は「認可指標利用上限」やマスターデータサービス稼働状況を確認してください。
追加購入指標「付加価値サービス」指標のみ追加可能。指標ごとの「利用上限」を入力(1以上の整数値のみ有効)。
3.2.2.5 運用ボード​