IM-Mail for Accel Platform 仕様書 第3版 2015-08-01

IM-Mail 機能

SSO(シングルサインオン)

シングルサインオンとは、1回の認証で異なるシステムやアプリケーションに一度にアクセスできるシステムのことを指します。
IM-Mail は、IM-Mail(メールサービス部分)にシングルサインオンする仕組みを提供します。
通常 IM-Mail(メールサービス部分)へ遷移する際には認証が必要です(図 通常認証)が、この機能によって intra-mart Accel Platform から IM-Mail(メールサービス部分)のログイン画面で認証をすることなく、利用できます。(図 シングルサインオン)
シングルサインオンを行う際には、認証キーが必要です。
認証キーの設定は「IM-Mail セットアップガイド」を参照してください。
IM-Mail(メールサービス部分)にログインした後は、 intra-mart Accel Platform のネットワークを経由することなく、 intra-mart Accel Platform を利用しているブラウザのウインドウとは、別のウインドウ上に IM-Mail(メールサービス部分)の画面が表示され、ユーザは IM-Mail(メールサービス部分)と直接接続を行います。
そのため、 intra-mart Accel Platform 上で一定期間操作を行わない場合はセッションが破棄され、 intra-mart Accel Platform に再度ログインが必要です。
intra-mart Accel Platform のセッションが破棄された場合でも、IM-Mail(メールサービス部分)との接続は保持されたままです。
システム的に SSO の認証に失敗するケースは以下です。
  • アカウントが存在しない
  • アカウントステータスが「利用不可」の場合
  • 認証用キーが不正の場合
../../_images/sso_before.png

図 通常認証

../../_images/sso_after.png

図 シングルサインオン

アカウント連携

アカウント連携は、intra-mart Accel Platform のアカウント情報を IM-Mail(メールサービス部分)のメールサービスコントロールパネル外部連携用 API(https 通信)を利用し、リアルタイム同期を行う機能です。
連携した場合に intra-mart Accel Platform 側のアカウントと IM-Mail(メールサービス部分)に登録されたアカウント情報(メールアドレス)を利用してシングルサインオンを実現しています。
また、アドレス帳(グローバルアドレスリスト)から参照できます。
連携を行う場合は、連携システム認証キーの設定が必要です。
連携システム認証キーの設定は「IM-Mail セットアップガイド」を参照してください。
連携したアカウント情報を IM-Mail(メールサービス部分)のメールサービスコントロールパネルより更新した場合は、IM-Mail に反映されず、同期したデータに不整合が発生します。
このような操作を行わないように注意してください。
../../_images/sync.png

図 アカウント同期

同期条件

intra-mart Accel Platform からIM-Mail(メールサービス部分)に同期されるアカウントには以下の条件があります。
  • ログインできるアカウントであること(アカウントライセンスが有効である)
  • アカウントの有効期間が有効であること(現在日時で有効である)
  • IM-Mail のアプリケーションライセンスが付与されていること
  • ユーザプロファイルが有効であること
  • IM-Mail 用のアカウント名、ドメイン名、グループ名が設定されていること
ユーザ名など、プロファイルの国際化情報は、テナント・ロケールの国際化情報を同期対象としています。

同期タイミング

同期条件を満たした場合に intra-mart Accel Platform から IM-Mail(メールサービス部分)に対して同期処理が実行されます。
同期をおこなう処理種別は2種類あります。
  1. 画面操作からユーザ情報の更新をおこなった時の伝搬、リスナの実行
  2. ジョブ起動からの実行

画面操作からの同期

テナント管理者の画面からユーザ情報を変更した際に、同期処理が実行されます。
以下、一例です。
  • ユーザ情報が変更・削除された場合(図 ユーザ詳細画面)
  • アカウントに対してライセンスが登録・削除された場合(図 アカウントライセンス一覧画面、図 ユーザ詳細画面(アカウントタブ))
  • アカウントに対して、IM-Mail のアプリケーションライセンスが登録・削除された場合(図 アプリケーションライセンス一覧画面)
  • ユーザプロファイルが変更された場合(図 ユーザ詳細画面(プロファイルタブ))
会社情報を変更した場合は、同期対象のユーザ数が多数になる可能性があるため、同期処理を実行しません。
後述する組織改変通知をご利用ください。
../../_images/im_master_user_update.jpg

図 ユーザ詳細画面

../../_images/account_license_list.jpg

図 アカウントライセンス一覧画面

../../_images/application_license_list.jpg

図 アプリケーションライセンス一覧画面

../../_images/im_master_user_account.jpg

図 ユーザ詳細画面(アカウントタブ)

../../_images/im_master_user_profile.jpg

図 ユーザ詳細画面(プロファイルタブ)

ログインユーザの個人設定画面から以下の操作により同期処理が実行されます。
  • パスワード情報が変更された場合
../../_images/password_update.jpg

図 パスワード変更画面

ジョブ実行からの同期

後述の「伝搬機能とリスナ」を参照してください。

IM-Mail(メールサービス部分)とのデフォルトカラムマッピング

IM-Mail(メールサービス部分)に同期するアカウント情報は下表<同期アカウント情報>の通りです。
IM-Mail(メールサービス部分)と intra-mart Accel Platform では、保存できるデータサイズが異なります。
そのため、IM-Mail(メールサービス部分)のサイズに合わせる処理が実装されています。

<同期アカウント情報>

IM-Mail(メールサービス部分) intra-mart Accel Platform 説明
項目 パラメータ名 項目 パラメータ名  
アカウント account IM-Mail 個人設定 - アカウント名 account  
IM-Mail 個人設定 - ドメイン名 domain  
グループ group IM-Mail 個人設定 - グループ名 group  
パスワード password アカウントパスワード password  
sn ユーザプロファイル - ユーザ名 familyName テナント・ロケールの国際化情報が有効期限内で存在しない場合は、アカウント名が利用されます。
姓(フリガナ) PhoneticLastName ユーザプロファイル - ユーザ名(カナ) firstName GALでカナ検索を行うのに利用されます。
表示名 DisplayName ユーザプロファイル - ユーザ名 displayName 姓と同じ値が設定されます。
電話番号 telephoneNumber ユーザプロファイル - 電話番号 tel  
会社 company 主所属の会社が設定されます。 company 主所属の会社が設定されます。
役職 title ユーザプロファイル - 所属役職 title 主所属の役職が設定されます。

伝搬機能とリスナ

ライセンス更新の伝搬

アカウントライセンスとアプリケーションライセンスを追加・削除すると、IM-Propagation によって更新内容が伝搬されます。
同期の条件を満たしている場合に IM-Mail(メールサービス部分)に対してアカウント情報の同期処理を実行します。
../../_images/license_propagation.png

図 ライセンス更新の伝搬 シーケンス図

アカウント更新の伝搬

アカウント情報を追加・変更・削除すると、IM-Propagation によって更新内容が伝搬されます。
同期の条件を満たしている場合に IM-Mail(メールサービス部分)に対してアカウント情報の同期処理を実行します。
../../_images/account_propagation.png

図 アカウント更新の伝搬 シーケンス図

UserListener

ユーザのプロファイル情報を追加・変更・削除した際に動作するリスナです。
同期の条件を満たしている場合に IM-Mail(メールサービス部分)に対してアカウント情報の同期処理を実行します。
../../_images/user_listener.png

図 UserListener シーケンス図

CompanyListener

ユーザの所属情報を追加・変更・削除した際に動作するリスナです。
同期の条件を満たしている場合に IM-Mail(メールサービス部分)に対してアカウント情報の同期処理を実行します。
../../_images/company_listener.png

図 CompanyListener シーケンス図

未読ポートレット

未読メールポートレットは、intra-mart Accel Platform のポータルに設置できるユーザ向けのポートレットです。
未読ポートレットでは、IM-Mail(メールサービス部分)にある未読メールの情報を表示します。
また、未読メールは通常の IMAP(またはIMAPS)プロトコルで接続して、データを取得します。
ただし、表示できる未読メールの情報は、受信箱のもののみであり、受信箱以外のフォルダは対象外です。(受信箱配下の階層フォルダも同様です。)
表示する情報は下表<未読メール表示情報>の通りです。表示できる件数は変更可能です。
変更方法については「IM-Mail セットアップガイド」の「ポートレット設定」を参照してください。
<未読メール表示情報>
項目 説明
未読数 受信箱にある未読メール数です。
総数 受信箱にあるメールの総数です。
優先度(重要度)
メールの優先度を示します。
高い場合:「priority_high」アイコンを表示します。
低い場合:「priority_low」アイコンを表示します。
件名 メールの件名です。
From メールの差出人です。
受信 メールを受信した日時です。
サイズ メールのサイズです。

コラム

未読ポートレットを使用するためには、IM-Mail(メールサービス部分)の IMAP 設定が有効になっている必要があります。
これは、IM-Mail アカウント登録時に自動的に有効化されます。

IMAP 設定を変更する場合は、メールサービスコントロールパネルの「アカウント管理」-「検索」-「アカウント情報」-「IMAP設定」より「IMAPを有効にする」を変更します。
../../_images/imap_setting.png

ジョブ

IM-Mail では、標準で4つのジョブを用意しています。
画面操作では、1リクエストで1ユーザのIM-Mail(メールサービス側)への同期処理を行いますが、ジョブでは、1リクエストで複数ユーザの処理を行います。
同時に処理するユーザ数の上限値は、設定ファイルで変更することが可能です。
設定は「IM-Mail セットアップガイド」を参照してください。
同時に処理するユーザ数の上限値は、メールサービスコントロールパネルで管理している処理可能上限数を超過することはできません。
超過した場合、そのリクエストに対するユーザの処理は、全てエラーとして処理されます。
ジョブ処理でエラーとなった場合、ユーザ情報をリカバリ用テーブル(im_mail_recovery)に記録します。
また、リカバリ用テーブルからデータが削除されるタイミングは、ジョブから同期処理が成功した場合のみです。
../../_images/batch.png

図 ジョブ実行

組織改変通知

アカウント連携によって同期が行われる部門情報は、階層構造を取り扱うことが可能です。(設定に関しては次節の拡張機能を参照ください。)
このため、階層の上位層が変更となった場合、変更のある階層以下のすべてのユーザの部門情報を更新する必要があります。
ですが、会社・組織画面で会社名を編集する場合、大量のユーザ情報を通知する必要が生じるため、伝搬機能やリスナによる同期処理を行っておりません。
そのため、上記の操作を行うと intra-mart Accel Platform と IM-Mail(メールサービス部分)の部門情報に不整合が発生します。
組織改変通知は、この不整合を回避するためのジョブです。

注意

このジョブで連携される情報は会社と役職に関するもののみです。
Ver.8.0.2 からIM-Mail(メールサービス部分)側の仕様変更により、組織に関する情報は連携されなくなりました。

ユーザ有効期限・所属変更

intra-mart Accel Platform はユーザ情報を期間化できます。
このため、将来連携対象となるユーザや、将来連携対象ではなくなるユーザプロファイルを作成できます。
上記のようなユーザに対して、画面からの操作では同期処理を実行できません。
ユーザ有効期限・所属変更は、このようなユーザを対象とした同期処理を実行するためのジョブです。
このジョブは、日時でのスケジューラを前提としています。
対象は「ジョブの実行日に期間開始、または期間終了するユーザのみ」です。
監視する有効期間はアカウント、プロファイル、組織主所属の情報です。
../../_images/term_start.png

図 有効期間開始

../../_images/term_end.png

図 有効期間終了

注意

ジョブの実行日は、システム・タイムゾーンにおける日付で判定されます。

リカバリデータ一括反映

先の記述の通り、ジョブは複数ユーザを処理しますが、トランザクションの単位は外部システムへの1リクエストです。
そのため、1ユーザのエラーによってその他のユーザもエラーとして扱われてしまいます。
リカバリデータ一括反映ジョブは、失敗となったユーザに対して再度同期処理を実行するためのジョブです。
../../_images/recovery.png

図 リカバリ処理

個人設定一括反映

このジョブの同期対象は、IM-Mail の利用条件を満たしている全ユーザです。
このジョブを利用することで、intra-mart Accel Platform 上にある既存の大量ユーザを一括で連携させることができます。

国際化について

intra-mart Accel Platform は国際化情報を持つことができます。しかし、IM-Mail(メールサービス部分)は各言語で取り扱うデータは共通です。
このため、IM-Mail(メールサービス部分)に対して連携する国際化情報は、1ロケール分の情報のみです。
intra-mart Accel Platform 側から送信するユーザ名などの国際化情報は、ユーザ・ロケールの国際化情報ではなく、テナント・ロケールの国際化情報です。

モバイル対応

IM-Mail(メールサービス部分)では携帯(フルブラウザ)/スマートフォンに対応しています。
しかし、SSO については対応していません。
携帯のブラウザでは受信箱のみ表示可能となっており、それ以外のフォルダを閲覧することはできません。