質問
⚠️ この事例は公開されてから1年以上経過しています。 情報が古い可能性がありますので、ご注意ください。
🕓 事例公開日 : 2025-02-11
【背景】
プッシュ通知機能をIM-Noticeで実現したいと考えています。Accel-Mart PlusでIM-Noticeを利用する際の実現性を確認する必要があります。対象機能はIM-NoticeのPC版とモバイル版の両方で、ログイン認証方式はSAML認証モジュールを用いたSSOとなります。
Q1.
Accel-Mart PlusでIM-Noticeを利用する際にサポートサイトへ依頼する作業はありますか?また、利用時の制約・制限事項があれば教えてください。
回答
A1.
サポートサイトへご依頼いただく作業はございません。
ただし、Accel-Mart PlusではIM-NoticeよりもAccel Platform Mobileの利用を推奨しております。製品の制限事項により、Accel Platform MobileとIM-Noticeにおける通知機能の同時利用は非対応ですのでご注意ください。
詳細は以下ドキュメントをご参照ください:
intra-mart Accel Platform Accel Platform Mobile リリースノート - Accel Platform Mobile に関する制限事項
モバイル版について
モバイル版の設定については以下のドキュメントをご参照ください:
・intra-mart Accel Platform セットアップガイド - モバイル通知機能(iOS版)
・intra-mart Accel Platform セットアップガイド - モバイル通知機能(Android版)
SAML認証について
SAML認証をご利用いただいていてもIM-Noticeはご利用可能です。IM-NoticeはOAuth認証モジュールが必要となりますので、こちらのモジュールが含まれているかご確認をお願いいたします。
PC版(デスクトップ通知)について
PC版であるデスクトップ通知につきましては、現在のところ、Accel-Mart Plus 環境では正式なサポート対象として対応しておりません。
しかしながら、参考情報として以下の手順によりご利用いただける可能性がございます。
以下の手順をご参照いただき、ご契約者様にて動作確認を実施していただきますようお願い申し上げます。
なお、こちらの情報は正式なサポート外の内容となりますため、動作の保証をお約束するものではございません。
あくまでご契約者様の判断に基づきご利用いただければ幸いです。
※以下の手順は、「カスタムサーバにブローカーサービスをインストール」する前提で記載されています。
ご契約者様が用意した独自サーバを利用するなど、カスタムサーバ以外でブローカーサービスを稼働させる場合は、適宜読み替えてください。
※補足 : カスタムサーバとは、弊社提供の標準 OS 上でミドルウェア等のカスタマイズが可能なサーバです。
Accel-Mart Plus サービスの追加リソースとして利用が可能です。カスタムサーバのお申し込みを希望される場合は、弊社営業担当までご連絡ください。
- Accel-Mart Plus サービス仕様書 - 追加リソース
全体の流れ
- 1. IM-Notice の通知機能全般を使用するための設定
- 2. デスクトップ通知機能設定
- 3. モジュール反映とテナント環境セットアップ
- 4. 接続情報更新の設定
- 5. ブローカーサービスの取得と実行
- 6. IM-Notice (デスクトップ版)のセットアップ
- 関連ドキュメント
- 関連FAQ
- 留意点
デスクトップ通知機能の利用には IM-Notice を利用していることが前提です。
- intra-mart Accel Platform セットアップガイド - IM-Notice
- intra-mart Accel Platform IM-MessageHub プログラミングガイド - IM-MessageHub 概要
※ なお、Accel-Mart Plus 環境でデスクトップ通知機能を利用する場合、intra-mart Accel Platform セットアップガイドの IM-Notice に関するドキュメントとは一部異なる設定箇所があります。事前に設定が完了している場合でも、以下手順を参照して設定ファイルなどを見直してください。
また、IM-Notice をまだ利用していない場合は、以下の手順に沿って IM-Notice(通知機能)を使用するための設定を行なってください。
1. IM-Notice の通知機能全般を使用するための設定
1-1. IM-Juggling でモジュールを選択します。
- モジュール選択の詳細な方法は以下ドキュメントに記載されています。
- IM-Notice - 通知機能全般 - モジュールの選択
1-2. IM-Notice 設定ファイルの編集
- IM-Notice の設定ファイル(im-notice-config.xml)を編集します。
- 設定値については以下のドキュメントを参考に設定してください。
- IM-Notice - 通知機能全般 - IM-Notice 設定ファイルの編集
- 設定値については以下のドキュメントを参考に設定してください。
※ベース URLは、運用管理サイトの「契約内容参照画面」-「intra-mart環境情報」 - 「環境情報」 - 「ログインURL」からご確認いただけます。
- ベースURLは、「ログインURL」の以下の部分となります。
- https://[ホスト名].[ドメイン名]/[WEBアプリケーション名]
- Accel-Mart Plus 運用者操作ガイド - 契約内容参照
2. デスクトップ通知機能設定
Accel-Mart Plus 環境でデスクトップ通知を利用する場合は、ブローカーサービスの利用を推奨しています。
そのため、ブローカーサービスを実行するサーバの起動、および、設定ファイルの編集が必要です。
2-1. IM-Notice MQ 設定ファイルの編集
- はじめに、IM-Juggling で出力された IM-Notice MQ 設定ファイル(im-notice-mq-config.xml)を以下の通り編集してください。
- 以下ファイルで編集するタグは <address> タグと <endpoint> タグです。
<?xml version="1.0" encoding="UTF-8"?>
<im-notice-mq-config
xmlns="http://www.intra-mart.jp/notice/mq/config/im-notice-mq-config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.intra-mart.jp/notice/mq/config/im-notice-mq-config ../schema/im-notice-mq-config.xsd">
<!--
書式 = tcp://{ <ブローカー> を実行しているサーバのホスト または IPアドレス}:{ブローカーの **バックエンド** ポート番号}
この例では、[カスタムサーバ] 上で <ブローカー> を起動しています。
以下の <address> タグは、[カスタムサーバ] の Private IP を指定します。
デフォルトでは40609ポートを使用しています。
-->
<address bind="false">tcp://**.***.***.***:40609</address>
<ping enable="true" interval-seconds="270" time-to-live-seconds="300" />
<endpoints>
<!--
書式 = tcp://{ <ブローカー> を実行しているサーバのホスト または IPアドレス}:{ブローカーの **フロントエンド** ポート番号}
この例では、[カスタムサーバ] 上で <ブローカー> を起動しています。
以下の <endpoint> タグは、[カスタムサーバ] の Global IP を指定します。
デフォルトでは40608ポートを使用しています。
-->
<endpoint>tcp://**.***.***.***:40608</endpoint>
</endpoints>
<zmq-io-threads>1</zmq-io-threads>
<zmq-max-sockets>1024</zmq-max-sockets>
<zmq-linger>1000</zmq-linger>
</im-notice-mq-config>
3. モジュール反映とテナント環境セットアップ
2 までの手順で、IM-Juggling にて出力した設定ファイルの編集は完了です。
3-1. 作成した WAR ファイルと静的ファイルを反映します。
- 運用管理機能の「モジュール反映」を用いて、作成したWARファイル・静的ファイルをデプロイしてください。
- モジュール反映方法は以下ドキュメントを参照してください。
- Accel-Mart Plus 運用者操作ガイド - モジュール反映
3-2. テナント環境セットアップを実施
- モジュール反映が正常完了した後、ご契約者様の環境にシステム管理者でログインし、システム管理画面にて、テナント環境セットアップを実行してください。
- テナント環境セットアップの詳細は、以下ドキュメントを参照してください。
- intra-mart Accel Platform セットアップガイド - テナント環境セットアップ
4. 接続情報更新の設定
- 通知を受け取るためには、運用管理サイトの接続情報更新にて、「デスクトップ通知アプリ(クライアント側)」と「ブローカー」との接続を許可する設定が必要です。
- 今回の例ではデフォルトの値のため、以下のように設定しています。(設定値については、ご契約者様の利用状況に応じて変更してください。)
- セキュリティグループ : バックエンド
- 開始ポート:40608
- 終了ポート:40608
- 接続元IPアドレス:許可する接続元IPアドレス(デスクトップ通知アプリを利用するクライアント側)を設定してください。
- 接続情報更新の設定方法については、以下のドキュメントを参照してください。
- Accel-Mart Plus スタートアップガイド - 接続情報更新
- Accel-Mart Plus 運用者操作ガイド - 接続情報更新
5. ブローカーサービスの取得と実行
5-1. ブローカーサービス実行ファイルの取得
- ブローカーサービスの実行ファイル(im_notice_mq_broker.zip)を取得します。
- 実行ファイルは弊社サイトの「プロダクトファイルダウンロード」よりライセンスキーを入力して取得してください。
- https://icotto.intra-mart.jp/imart/forma/normal/view/regist_application_view/srcDownload
- ライセンスキーは「運用管理サイト」-「システム環境構築」-「ライセンス管理」より確認してください。
- 運用管理サイトアクセス先 URL とログイン情報は、開通通知書の「Accel-Mart Plus環境情報」に記載されています。
- 実行ファイルは弊社サイトの「プロダクトファイルダウンロード」よりライセンスキーを入力して取得してください。
- im_notice_mq_broker.zip をカスタムサーバに転送後、カスタムサーバに SSH 接続し、zip ファイルを展開します。
- カスタムサーバへの SSH 接続は、カスタムサーバを契約したご契約者様のみ利用可能です。
- SSH ログインする方法は以下のドキュメントを参照してください。
- Accel-Mart Plus スタートアップガイド - (オプション)OSへのSSHログイン
5-2. IM-Notice MQブローカー設定ファイルの編集
- im_notice_mq_broker.zip を展開した conf ディレクトリ内の IM-Notice MQブローカー設定ファイル(im-notice-mq-broker-config.xml)を編集します。
- 設定値については以下のドキュメントに記載されている通り、デフォルトの設定値のままで問題ありません。
- IM-Notice - 通知機能全般 - IM-Notice MQブローカー設定ファイルの編集
- 設定値については以下のドキュメントに記載されている通り、デフォルトの設定値のままで問題ありません。
5-3. ブローカーサービスの実行
- ディレクトリ内にある im_notice_mq_broker-8.0.x.jar を java コマンドで実行してください。
- ブローカーサービスの実行時には、SSH 接続が切断された後もプロセスが継続されるよう、バックグラウンドで動作させてください。
- java コマンドについては、以下のドキュメントを参照してください。
- IM-Notice - 通知機能全般 - ブローカーサービスの実行
6. IM-Notice (デスクトップ版)のセットアップ
デスクトップ通知の利用には IM-Notice (デスクトップ版)のセットアップが必要です。
以下の手順に沿ってセットアップを行なってください。
6-1. クライアント要件の確認
- デスクトップ通知を利用する場合は、 リリースノートに記載されているシステム要件を満たしている必要があります。
- 以下ドキュメントを参照し、IM-Notice 利用時のクライアント要件を満たしていることを確認してください。
- intra-mart Accel Platform IM-Notice ユーザ操作ガイド(デスクトップ版) - IM-Notice (デスクトップ版)について
6-2. IM-Notice (デスクトップ版)のダウンロードとインストール
- ダウンロードやインストール方法については、以下のドキュメントを参照してください。
- intra-mart Accel Platform IM-Notice ユーザ操作ガイド(デスクトップ版) - セットアップ
6-3. IM-Notice (デスクトップ版)の操作方法
- 基本的な操作方法については、以下のドキュメントを参照してください。
- intra-mart Accel Platform IM-Notice ユーザ操作ガイド(デスクトップ版) - 操作
関連ドキュメント
- intra-mart Accel Platform セットアップガイド - IM-Notice
- Accel-Mart Plus 運用者操作ガイド - モジュール反映
- Accel-Mart Plus スタートアップガイド - 接続情報更新
- Accel-Mart Plus 運用者操作ガイド - 接続情報更新
- IM-Notice ユーザ操作ガイド(デスクトップ版)
関連FAQ
- モジュール反映後、テナント画面にログインするとエラー画面が表示されます。解決方法を教えてください。
留意点
- 上述の方法は、提案・参考程度の情報です。
- ご契約者様側での検証が必要ですので、承知いただいた上で、実施を検討してください。
- 作業開始前に「 オフラインバックアップ 」の取得を推奨します。
- モジュール反映が正常完了した後、必ず「テナント環境セットアップ」を実施してください。
- 「テナント環境セットアップ」が未実施の場合、デスクトップ通知が正常に行われませんので、注意してください。
- IM-Notice を利用するには、OAuth 認証モジュールが必要です。
- IM-Notice は統合 Windows 認証環境では利用できません。
- IM-Notice と Accel Platform Mobile のモバイル通知の同時利用は非対応です。
- Accel-Mart Plus環境でIM-Noticeをモバイル通知機能を利用するには、お客様にて1つAWSアカウントをご用意していただく必要がございます。
- 通知をデスクトップアプリで受け取るには、デスクトップ通知の設定を有効にする必要があります。
- IMBox の通知に関する詳細は以下ドキュメントを参照してください。
- intra-mart Accel Platform IMBox ユーザ操作ガイド - 通知を設定する
- IMBox の通知に関する詳細は以下ドキュメントを参照してください。
- メッセージが通知されるごとにデスクトップにバルーンが表示されるようになります。
- 「表示設定」で「ダイアログで通知する」を設定すると、メッセージが通知されるごとにバルーンではなく、ダイアログで表示されます。
- 表示設定は以下のドキュメントを参照してください。
- intra-mart Accel Platform IMBox ユーザ操作ガイド - 通知を設定する - 表示の設定をする
- なお、バルーンとダイアログを同時に表示させることはできません。
- 手順通りに設定しても通知が行なわれない場合は、以下を確認してください。
- システム要件の確認
- 各サーバ間の通信が正常に行なえる状態であることの確認 (プロキシやファイヤウォール、ルーターなど、ご契約者様側のネットワーク環境の問題により通信が遮断されていないかなど)
- 各種設定ファイルの設定値 (im-notice-config.xml やim-notice-mq-config.xml など)
- 接続情報更新のポートや接続元 IP アドレス設定
- ブローカーの起動有無
- テナント環境セットアップの実施有無
- また、これら方法に関する詳細のお問い合わせは、標準サービスのサポート範囲外です。引き続きのサポートが必要な場合は、有償の技術支援の利用を検討してください。その際は、弊社営業にお気軽にお問い合わせください。
以上となります。
よろしくお願いいたします。