intra-mart Accel Platform 設定ファイルリファレンス 第26版 2020-08-01

IM-Notice Mobile設定

概要 **

モバイル通知機能に関する設定です。
モジュール モバイル通知機能
フォーマットファイル(xsd) WEB-INF/schema/im-notice-mobile-config.xsd
設定場所 WEB-INF/conf/im-notice-mobile-config.xml

<?xml version="1.0" encoding="UTF-8"?>

<im-notice-mobile-config
    xmlns="http://www.intra-mart.jp/notice/mobile/config/im-notice-mobile-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/notice/mobile/config/im-notice-mobile-config ../schema/im-notice-mobile-config.xsd">

    <proxy enable="false">
        <host></host>
        <port xsi:nil="true"></port>
        <username></username>
        <password></password>
        <workstation></workstation>
        <domain></domain>
    </proxy>

    <asns name="asns-apns">
        <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint>
        <platform-application-arn></platform-application-arn>
        <access-key></access-key>
        <secret-key></secret-key>
    </asns>

    <asns name="asns-fcm">
        <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint>
        <platform-application-arn></platform-application-arn>
        <access-key></access-key>
        <secret-key></secret-key>
        <fcm-project-id></fcm-project-id>
        <fcm-application-id></fcm-application-id>
        <fcm-api-key></fcm-api-key>
        <fcm-sender-id></fcm-sender-id>
    </asns>

    <asns name="asns-baidu">
        <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint>
        <platform-application-arn></platform-application-arn>
        <access-key></access-key>
        <secret-key></secret-key>
        <baidu-api-key></baidu-api-key>
    </asns>

    <fcm name="fcm">
        <url>https://fcm.googleapis.com/fcm/send</url>
        <project-id></project-id>
        <application-id></application-id>
        <api-key></api-key>
        <server-key></server-key>
        <project-number></project-number>
    </fcm>

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

    <max-push-subject-length>30</max-push-subject-length>
    <max-push-body-length>70</max-push-body-length>
</im-notice-mobile-config>

リファレンス

プロキシの設定

タグ名 proxy
Amazon SNSやFirebase Cloud Messagingへ接続するためのプロキシを設定します。

【設定項目】

<im-notice-mobile-config>
    <proxy enable="false">
        ・・・・・
    </proxy>
</im-notice-mobile-config>

必須項目
複数設定 ×
設定値・設定する内容 プロキシを使用する際に必要な設定をしてください。
単位・型 なし
省略時のデフォルト値 なし
親タグ im-notice-mobile-config

【属性】

属性名 説明 必須 デフォルト値
enable
プロキシを使用する場合、trueを設定してください。
プロキシを使用しない場合、falseを設定してください。
false

ホストの設定

タグ名 host
プロキシサーバのIPアドレスを設定します。

【設定項目】

<proxy enable="true">
    <host>XXX.XXX.XXX.XXX</host>
</proxy>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 文字列
省略時のデフォルト値 なし
親タグ proxy

ポート番号の設定

タグ名 port
プロキシサーバのポート番号を設定します。

【設定項目】

<proxy enable="true">
    <port>XXXX</port>
</proxy>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 数値(0-)
省略時のデフォルト値 なし
親タグ proxy

【属性】

属性名 説明 必須 デフォルト値
xsi:nil
ポート番号を指定する場合、この属性を削除してください。
ポート番号を指定しない場合、trueを設定してください。
× true

ユーザ名の設定

タグ名 username
プロキシ使用時にユーザ認証が必要な場合、ユーザ名を設定します。

【設定項目】

<proxy enable="true">
    <username>XXXXXXXX</username>
</proxy>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 文字列
省略時のデフォルト値 なし
親タグ proxy

パスワードの設定

タグ名 password
プロキシ使用時にユーザ認証が必要な場合、パスワードを設定します。

【設定項目】

<proxy enable="true">
    <password>XXXXXXXX</password>
</proxy>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 文字列
省略時のデフォルト値 なし
親タグ proxy

ワークステーションの設定

タグ名 workstation
NTLM認証を行っている場合、ワークステーションを設定します。

【設定項目】

<proxy enable="true">
    <workstation>XXXXXXXX</workstation>
</proxy>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 文字列
省略時のデフォルト値 なし
親タグ proxy

ドメインの設定

タグ名 domain
NTLM認証を行っている場合、ドメインを設定します。

【設定項目】

<proxy enable="true">
    <domain>XXXXXXXX</domain>
</proxy>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 文字列
省略時のデフォルト値 なし
親タグ proxy

Amazon SNSの設定

タグ名 asns
Amazon SNSを使用するための項目値を設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-apns">
        ・・・・・
    </asns>
</im-notice-mobile-config>

必須項目
複数設定
設定値・設定する内容 Amazon SNSを使用するために必要な設定をしてください。
単位・型 なし
省略時のデフォルト値 なし
親タグ im-notice-mobile-config

【属性】

属性名 説明 必須 デフォルト値
name
任意の名前を設定してください。
pushタグのengine要素で通知方法を設定する際に使用します。
asns-apns,asns-fcm

エンドポイントの設定

タグ名 endpoint
エンドポイントを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-apns">
        <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint>
    </asns>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
使用するリージョンに対応するAmazon SNSサービスアクセスポイントを設定してください。
各リージョンのエンドポイントは AWS documentation - Regions and Endpoints で確認できます。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ asns

Amazon リソースネームの設定

タグ名 platform-application-arn
Amazonリソースネームを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-apns">
        <platform-application-arn>arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:app/APNS/IM-Notice_APNS</platform-application-arn>
    </asns>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Amazon SNSで作成したアプリケーションのApplication ARNを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ asns

アクセスキーの設定

タグ名 access-key
アクセスキーを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-apns">
        <access-key>XXXXXXXXXXXXXXXXXXXX</access-key>
    </asns>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 AWSで作成したアクセスキーを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ asns

シークレットキーの設定

タグ名 secret-key
シークレットキーを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-apns">
        <secret-key>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</secret-key>
    </asns>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 AWSで作成したシークレットキーを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ asns

Firebase Cloud MessagingのプロジェクトIDの設定

タグ名 fcm-project-id
FirebaseプロジェクトのプロジェクトIDを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-fcm">
        <fcm-project-id>XXXXXXXXXXXX</fcm-project-id>
    </asns>
</im-notice-mobile-config>

必須項目 通知手段にAmazon SNS+Firebase Cloud Messagingを利用する場合に必須
複数設定 ×
設定値・設定する内容 Firebaseで作成したプロジェクトのプロジェクトIDを設定してください。
単位・型 文字列
省略時のデフォルト値 なし
親タグ asns

Firebase Cloud MessagingのアプリケーションIDの設定

タグ名 fcm-application-id
Firebaseプロジェクトに追加したAndroidアプリのアプリケーションIDを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-fcm">
        <fcm-application-id>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</fcm-application-id>
    </asns>
</im-notice-mobile-config>

必須項目 通知手段にAmazon SNS+Firebase Cloud Messagingを利用する場合に必須
複数設定 ×
設定値・設定する内容 Firebaseプロジェクトに追加したAndroidアプリのアプリケーションIDを設定してください。
単位・型 文字列
省略時のデフォルト値 なし
親タグ asns

Firebase Cloud MessagingのウェブAPIキーの設定

タグ名 fcm-api-key
Firebaseで作成したプロジェクトのウェブAPIキーを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-fcm">
        <fcm-api-key>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</fcm-api-key>
    </asns>
</im-notice-mobile-config>

必須項目 通知手段にAmazon SNS+Firebase Cloud Messagingを利用する場合に必須
複数設定 ×
設定値・設定する内容 Firebaseで作成したプロジェクトのウェブAPIキーを設定してください。
単位・型 文字列
省略時のデフォルト値 なし
親タグ asns

Firebase Cloud Messagingの送信者IDの設定

タグ名 fcm-sender-id
Firebase Cloud Messagingの送信者IDを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-fcm">
        <fcm-sender-id>XXXXXXXXXXXX</fcm-sender-id>
    </asns>
</im-notice-mobile-config>

必須項目 通知手段にAmazon SNS+Firebase Cloud Messagingを利用する場合に必須
複数設定 ×
設定値・設定する内容 Firebase Cloud Messagingの送信者IDを設定してください。
単位・型 文字列
省略時のデフォルト値 なし
親タグ asns

Baidu APIキーの設定

タグ名 baidu-api-key
Baidu APIキーを設定します。

【設定項目】

<im-notice-mobile-config>
    <asns name="asns-baidu">
        <baidu-api-key>XXXXXXXXXXXX</baidu-api-key>
    </asns>
</im-notice-mobile-config>

必須項目 通知手段にAmazon SNS+Baiduを利用する場合に必須
複数設定 ×
設定値・設定する内容 BaiduクラウドプロジェクトのAPIキーを設定してください。
単位・型 文字列
省略時のデフォルト値 なし
親タグ asns

Firebase Cloud Messagingの設定

タグ名 fcm
Firebase Cloud Messagingを使用するための設定をします。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        ・・・・・
    </fcm>
</im-notice-mobile-config>

必須項目
複数設定
設定値・設定する内容 Firebase Cloud Messagingを使用するために必要な設定をしてください。
単位・型 なし
省略時のデフォルト値 なし
親タグ im-notice-mobile-config

【属性】

属性名 説明 必須 デフォルト値
name
任意の名前を設定してください。
pushタグのengine要素で通知方法を設定する際に使用します。
fcm

URLの設定

タグ名 url
Firebase Cloud MessagingのURLを設定します。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        <url>https://fcm.googleapis.com/fcm/send</url>
    </fcm>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 https://firebase.google.com/docs/cloud-messaging/http-server-ref」を設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ fcm

プロジェクトIDの設定

タグ名 project-id
プロジェクトIDを設定します。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        <project-id>XXXXXXXXXXXX</project-id>
    </fcm>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Firebaseで作成したプロジェクトのプロジェクトIDを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ fcm

アプリケーションIDの設定

タグ名 application-id
アプリケーションIDを設定します。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        <application-id>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</application-id>
    </fcm>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Firebaseプロジェクトに追加したAndroidアプリのアプリケーションIDを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ fcm

APIキーの設定

タグ名 api-key
APIキーを設定します。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        <api-key>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</api-key>
    </fcm>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Firebaseで作成したプロジェクトのウェブAPIキーを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ fcm

サーバーキーの設定

タグ名 server-key
サーバーキーを設定します。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        <server-key>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</server-key>
    </fcm>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Firebase Cloud Messaging のサーバーキーを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ fcm

送信者IDの設定

タグ名 sender-id
送信者IDを設定します。

【設定項目】

<im-notice-mobile-config>
    <fcm name="fcm">
        <sender-id>XXXXXXXXXXXX</sender-id>
    </fcm>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Firebase Cloud Messagingの送信者IDを設定してください。
単位・型 文字列
省略時のデフォルト値 空文字
親タグ fcm

通知方法の設定

タグ名 push
各通知先へ通知を行う際に使用するサービスを設定します。

【設定項目】

<im-notice-mobile-config>
    <push type="android" engine="fcm" />
    <push type="ios" engine="asns-apns" />
</im-notice-mobile-config>

必須項目
複数設定
設定値・設定する内容 なし
単位・型 識別子
省略時のデフォルト値 なし
親タグ im-notice-mobile-config

【属性】

属性名 説明 必須 デフォルト値
type 通知先(android/ios)を設定してください。 × android,ios
engine 各通知先への通知方法(asnsタグまたはfcmタグのname属性に設定した名前)を設定してください。 fcm,asns-apns

通知タイトルの最長文字数の設定

タグ名 max-push-subject-length
Push通知受信時に表示するタイトルの最大文字数を設定します。

【設定項目】

<im-notice-mobile-config>
    <max-push-subject-length>30</max-push-subject-length>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Push通知受信時に表示するタイトルの最大文字数を設定してください。
単位・型 数値(0-)
省略時のデフォルト値 空文字
親タグ im-notice-mobile-config

通知内容の最長文字数の設定

タグ名 max-push-body-length
Push通知受信時に表示する本文の最長文字数を設定します。

【設定項目】

<im-notice-mobile-config>
    <max-push-body-length>70</max-push-body-length>
</im-notice-mobile-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Push通知受信時に表示する本文の最長文字数を設定してください。
単位・型 数値(0-)
省略時のデフォルト値 空文字
親タグ im-notice-mobile-config