11.6. IM-Notice¶

11.6.3.1.1. IM-Notice MQ設定ファイルの編集¶

1. <address>

   • デスクトップ通知で使用するポート番号を設定してください。

     デフォルトでは40608ポートを使用する設定です。

     クライアントからサーバまでのネットワーク機器などに対して、ここで指定したポートを開放してください。

     <address bind="true">tcp://*:40608</address>
     

2. <ping>

   • ping機能の設定をします。

     有効にするには、enable属性に「true」を設定してください。
   • interval-seconds属性で、クライアントにpingを流す間隔を設定します。単位は秒です。
   • time-to-live-seconds属性で、クライアントがサーバに再接続を行うまでの時間を設定します。単位は秒です。

     設定した秒数だけサーバから応答がなければ、クライアントはサーバに再接続を行います。

     <ping enable="true" interval-seconds="270" time-to-live-seconds="300" />
     

   コラム

   環境により、一定時間データが流れないソケットは切断されてしまう場合があります。

   そのような環境では、数分間隔でpingを流し続けることで自動切断を避けることができます。

   （Microsoft AzureやAmazon Elastic Compute Cloudなど）

3. <endpoint>

   • クライアントの接続先を設定します。

     <address>で設定したポート番号を指定してください。

     <endpoints>
         <endpoint>tcp://example.org:40608</endpoint>
     </endpoints>
     

11.6.3.2.1. IM-Notice MQ設定ファイルの編集¶

IM-Juggling で出力されたim-notice-mq-config.xmlを編集してください。

1. <address> および <endpoint>

   <address> の bind 属性に false を指定し、ブローカーのバックエンドポートの接続情報を設定してください。

   <endpoint> にブローカーのフロントエンドポートの接続情報を設定してください。

   <address bind="false">tcp://{ブローカーを実行しているサーバのホストまたはIPアドレス}:{ブローカーのバックエンドポート番号}</address>
   <ping enable="true" interval-seconds="270" time-to-live-seconds="300" />
   <endpoints>
     <endpoint>tcp://{ブローカーを実行しているサーバのホストまたはIPアドレス}:{ブローカーのフロントエンドポート番号}</endpoint>
   </endpoints>
   

コラム

IM-Notice MQ設定ファイルのその他の項目については IM-Notice MQ設定ファイルの編集 を参照してください。

11.6.3.2.2. ブローカーサービス実行ファイルの取得¶

11.6.3.2.3. IM-Notice MQブローカー設定ファイルの編集¶

1. <frontend>

   • デスクトップ通知アプリケーションとの通信を行うポート番号を設定してください。

     デフォルトでは40608ポートを使用する設定です。

     クライアントからブローカーまでのネットワーク機器などに対して、ここで指定したポートを開放してください。

     <frontend>tcp://*:40608</frontend>
     

2. <backend>

   • Web Application Server との通信を行うポート番号を設定してください。

     デフォルトでは40609ポートを使用する設定です。

     ブローカーからサーバまでのネットワーク機器などに対して、ここで指定したポートを開放してください。

     <backend>tcp://*:40609</backend>
     

コラム

IM-Notice MQブローカー設定ファイルのその他の項目は IM-Notice ブローカー設定ファイルと同様です。

IM-Notice ブローカー設定ファイルについては IM-Notice MQ設定ファイルの編集 を参照してください。

11.6.3.2.4. ブローカーサービスの実行¶

フォアグラウンドで動作させる場合（例）

java -jar im_notice_mq_broker-8.0.x.jar

nohup java -jar im_notice_mq_broker-8.0.x.jar > stdout.log 2>stderr.log &

コラム

実行したブローカーサービスを停止する場合は、実行方法に応じた停止を行ってください。

上記実行例に対する停止方法は以下です。

• フォアグラウンドでjavaコマンドを実行した場合、Ctrl-C で終了。
• バックグラウンドでjavaコマンドを実行した場合、プロセスIDを調べてkillコマンドで終了。

11.6.5.1.1. FCMの設定¶

FCMの設定を行います。

1. Firebase Console にログインしてください。
2. プロジェクトを作成します。

   

3. フォームに以下の内容を入力し、「続行」をクリックしてください。

   
   

   項目	説明
   プロジェクト名	任意の名前を入力してください。
   プロジェクトID	任意のIDを入力してください。

   

4. 「Googleアナリティクス」を無効にし、「プロジェクトの作成」をクリックしてください。

   （Googleアナリティクスを利用する場合は有効にして必要な設定をおこなってください。）

   

5. プロジェクトの準備ができたら、「続行」をクリックしてください。

   

6. 作成したプロジェクトをクリックしてください。

   

7. プロジェクトへAndroidアプリを追加します。「Androidアプリ追加」アイコンをクリックしてください。

   

8. フォームに以下の内容を入力し、「アプリを登録」をクリックしてください。

   
   

   項目	説明
   Android パッケージ名	jp.co.intra_mart.system.notice.android

   

9. 「次へ」をクリックし、４まで進めてください。

   

10. 「コンソールに進む」をクリックしてください。

    

11. プロジェクトの概要から設定を確認します。

    プロジェクト概要の歯車アイコンをクリックし、「プロジェクトを設定」をクリックしてください。

    

12. プロジェクトのプロジェクトID、ウェブAPIキーを確認します。

    設定ファイルを編集する際に必要な文字列ですので、控えておいてください。

    

13. マイアプリ - AndroidアプリのアプリIDを確認します。

    設定ファイルを編集する際に必要な文字列ですので、控えておいてください。

    

14. クラウドメッセージングタブへ移動し、プロジェクト認証情報のサーバーキー、送信者IDを確認します。

    設定ファイルを編集する際に必要な文字列ですので、控えておいてください。

    

11.6.5.1.2. IM-Notice Mobile設定ファイルの編集¶

• <proxy>

  1. Firebase Cloud Messagingへ接続するためにプロキシを使用する場合、設定を行ってください。

     <proxy enable="true">
         <host></host>
         <port xsi:nil="true"></port> <!-- ポート番号を指定する場合は xsi:nil="true" を削除してください。 -->
         <username></username>
         <password></password>
         <workstation></workstation>
         <domain></domain>
     </proxy>
     

• <fcm>

  1. <fcm>のname属性に任意の名前を設定してください。

     <fcm name="fcm">
         ....
     </fcm>
     

  2. <project-id>

     • FirebaseプロジェクトのプロジェクトIDを設定してください。

  3. <application-id>

     • AndroidアプリのアプリIDを設定してください。

  4. <api-key>

     • FirebaseプロジェクトのウェブAPIキーを設定してください。

  5. <server-key>

     • クラウドメッセージングのサーバーキーを設定してください。

  6. <sender-id>

     • クラウドメッセージングの送信者IDを設定してください。

     コラム

     各項目の確認方法は、 FCMの設定 を参照してください。

• <push type=”android” />

  1. engine属性に、<fcm>のname属性に設定した名前を指定してください。

  <push type="android" engine="fcm" />
  

• <max-push-subject-length>

  1. Push通知受信時に表示するタイトルの最大文字数を設定してください。

  <max-push-subject-length>30</max-push-subject-length>
  

• <max-push-body-length>

  1. Push通知受信時に表示する本文の最長文字数を設定してください。

  <max-push-body-length>70</max-push-body-length>
  

11.6.5.2.1. FCM の設定¶

FCMの設定を行います。

コラム

FCMの設定方法は、 FCMの設定 を参照してください。

11.6.5.2.2. Amazon SNS の設定¶

Amazon SNSの設定を行います。

1. Amazon SNS にサインインしてください。

   

2. リージョンを選択してください。

   

3. サービスを選択してください。

   

4. 「Mobile」-「プッシュ通知」から「プラットフォームアプリケーションの作成」をクリックしてください。

   

5. フォームに以下の内容を入力し、「プラットフォームアプリケーションの作成」をクリックしてください。

   
   

   項目	説明
   アプリケーション名	任意の名前を入力します。
   プッシュ通知プラットフォーム	「Firebase Cloud Messaging(FCM)」を選択します。
   APIキー	FCM の設定 で作成したサーバーキーを入力します。

   

   
   
6. アプリケーションが追加されました。

   「ARN」を確認します。

   設定ファイルを編集する際に必要な文字列ですので、控えておいてください。

   

11.6.5.2.3. IM-Notice Mobile設定ファイルの編集¶

• <proxy>

  1. Firebase Cloud MessagingやAmazon SNSへ接続するためにプロキシを使用する場合、設定を行ってください。

     <proxy enable="true">
         <host></host>
         <port xsi:nil="true"></port> <!-- ポート番号を指定する場合は xsi:nil="true" を削除してください。 -->
         <username></username>
         <password></password>
         <workstation></workstation>
         <domain></domain>
     </proxy>
     

• <asns>

  1. <asns>のname属性に任意の名前を設定してください。

     <asns name="asns-fcm">
         ....
     </asns>
     

  2. <endpoint>

     • Amazon SNSのリージョンに対応するEndpointを設定してください。

       <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint>
       

       コラム

       Endpointは AWS documentation - Regions and Endpoints で確認できます。

       リージョンが「Asia Pacific (Tokyo)」の場合、Endpointは「sns.ap-northeast-1.amazonaws.com」です。

  3. <platform-application-arn>

     • Application ARNを設定してください。

       コラム

       Application ARNの確認方法は、 Amazon SNS の設定 を参照してください。

  4. <access-key>

     • アクセスキーを設定してください。

  5. <secret-key>

     • シークレットキーを設定してください。

     コラム

     アクセスキーおよびシークレットキーは AWS Identity and Access Management（IAM） で作成できます。

     

  6. <fcm-project-id>

     • FirebaseプロジェクトのプロジェクトIDを設定してください。

  7. <fcm-application-id>

     • AndroidアプリのアプリIDを設定してください。

  8. <fcm-api-key>

     • FirebaseプロジェクトのウェブAPIキーを設定してください。

  9. <fcm-sender-id>

     • Firebase クラウドメッセージングの送信者IDを設定してください。

     コラム

     プロジェクトID等Firebase設定情報の確認方法は、 FCMの設定 を参照してください。

• <push type=”android” />

  1. engine属性に、<asns>のname属性に設定した名前を指定してください。

     <push type="android" engine="asns-fcm" />
     

• <max-push-subject-length>

  1. Push通知受信時に表示するタイトルの最大文字数を設定してください。

  <max-push-subject-length>30</max-push-subject-length>
  

• <max-push-body-length>

  1. Push通知受信時に表示する本文の最長文字数を設定してください。

  <max-push-body-length>70</max-push-body-length>