intra-mart Accel Platform IMBox 仕様書 第17版 2018-04-01

IMBoxFrame

IMBoxFrameとは

IMBoxFrame とは、任意の画面と IMBox の Box を同時に表示する機能です。
http://www.example.co.jp/imart/imbox/frame?boxType=MYBOX&url=home のような URL でアクセスします。
下図「IMBoxFrame」は上記URLの表示例です。
frame_001

図 IMBoxFrame

注意

IMBoxFrameは、2015 Spring(Juno)からご利用いただけます。

IMBoxFrameを表示するためのパラメータ

IMBoxFrameを表示するには、いくつかのパラメータを指定する必要があります。
  • boxType

    • 表示したい Box を示す文字列を指定します。
    • このパラメータの設定は必須です。
    • どのような値を指定するのかは「 表示したい Box と boxType の関係 」で説明します。
  • url

    • 表示したい任意の画面の URL を指定します。
    • URL は相対パス、または ベースURL から始まる絶対パスを指定します。
  • boxCd

  • threadId

    • 以下のBoxを表示する場合にスレッドIDの設定が必須です。

    • その他のBoxを表示する場合は設定不要です。

    • どのような値を指定するのかは「 スレッドIDの設定 」で説明します。

  • width

    • IMBox の幅をピクセル値で指定します。
    • 初期値 : 320

    注意

    幅の最小値は200ピクセルです。
    200ピクセル以下を指定した場合、最小値の200ピクセルで表示されます。
  • align

    • IMBox を画面の左右どちらに表示するのかを指定します。

    • 指定できる値は left, right のいずれかです。

    • 初期値 : right

      右寄せ

      図 right を指定した場合

      左寄せ

      図 left を指定した場合

  • title

    • タイトルを指定します。

    • タイトルが表示されるのは下図の赤枠で囲った部分です。

    • 初期値 : boxTypeに指定した値

      title

      図 title の表示位置

注意

IMBox そのもの、intra-mart Accel Collaboration のワークスペースの画面など、IMBox が表示されている画面を url に指定すると、新着通知が正常に届かない場合があります。

表示したい Box と boxType の関係

表示したい Box と boxType の関係、boxCd に指定する値は下表の通りです。
boxCdに関する詳細は、「 ボックスコードの設定 」を参照してください。
threadIdに関する詳細は、「 スレッドIDの設定 」を参照してください。
表示したい Box と boxType の関係
表示したい Box名 boxTypeへの設定値 boxCdへの設定値 threadIdへの設定値
MyBox MYBOX
CompanyBox COMPANYBOX
GroupBox GROUPBOX グループボックスコード
DirectMessageBox DIRECTMESSAGEBOX
ApplicationBox APPLICATIONBOX
TagBox TAGBOX タグ
プロフィールタイムライン USER_MESSAGE ユーザコード
MylistBox MYLIST_MESSAGE マイリストID
Likes LIKE_MESSAGE
Bookmarks BOOKMARK_MESSAGE
Notices NOTICE_MESSAGE
Unread Messages UNREAD_MESSAGE
UnitBox UNITBOX
スレッドID

ボックスコードの設定

表示したい Box のボックスコードは、下表「ボックスコードの設定値」をご確認ください。
ユーザコード、マイリストIDは、対象の Box を表示した際のアドレスバーの最後の文字をボックスコードに設定してください。
ボックスコードの設定値
表示したい Box名 boxCd 設定値詳細
GroupBox グループボックスコード 詳細 のグループボックスコードを設定。
TagBox タグ タグ の一覧に表示しているタグを設定。
プロフィールタイムライン ユーザコード 下図「ユーザコードの確認」のアドレスバーの最後の文字列を設定。
MylistBox マイリストID 下図「マイリストの確認」のアドレスバーの最後の文字列を設定。
ユーザコードの確認

図 ユーザコードの確認

マイリストIDの確認

図 マイリストIDの確認

注意

メニューアイテムからboxCdにタグを指定する場合、自動的にURLエンコードが行われます。
URLを直接入力する場合はURLエンコードを行った値を入力する必要があります。
例えば、TagBoxに表示したいタグ名が「Q&A」の場合、メニューアイテムからは引数にキー: boxCd 値:Q&Aを、URLを直接入力する場合はboxCd=Q%26Aと入力してください。

スレッドIDの設定

対象のスレッドを表示した際のアドレスバーの最後の文字をスレッドIDに設定してください。
スレッドIDの確認

図 スレッドIDの確認

メニュー設定例

IMBoxFrame を表示するメニューに登録する例は以下の通りです。
以下の例ではメニューアイテムの設定のみ記載していますが、必要に応じてメニューグループの追加や、認可の設定を行ってください。

コラム

メニュー設定に関する詳細は、「テナント管理者操作ガイド - メニューを設定する 」を参照してください。

ポータルと MyBox を表示する

メニューに以下のメニューアイテムを登録します。
メニューアイテム設定
項目名 設定値
メニューID 任意
メニューアイテム名 任意
URL imbox/frame
呼び出し方法 任意
引数1 キー: boxType 値: MYBOX
引数2 キー: url 値: home
ポータルと MyBox を表示する

図 ポータルと MyBox の設定例

サイトマップと GroupBox を表示し、IMBox を左に表示する

メニューに以下のメニューアイテムを登録します。
グループボックスコードは事前に取得しておいてください。
メニューアイテム設定
項目名 設定値
メニューID 任意
メニューアイテム名 任意
URL imbox/frame
呼び出し方法 任意
引数1 キー: boxType 値: GROUPBOX
引数2 キー: url 値: menu/sitemap
引数3 キー: boxCd 値: グループボックスコード
引数4 キー: align 値: left
サイトマップと GroupBox を表示し、IMBox を左に表示する

図 サイトマップと GroupBox の設定例

IMBoxFrameの操作

Boxを閉じる

IMBoxFrameで表示しているBoxを非表示状態にします。
Boxの右上の「閉じる」アイコンをクリックしてください。
閉じる

図 閉じるアイコン

Boxを開く

IMBoxFrameで非表示になっているBoxを表示状態にします。
Boxが非表示になっている状態では、以下のような「開く」アイコンがタブとしてIMBoxFrameの画面内に表示されます。
タブをクリックするとBoxが表示されます。
また、タブをドラッグすることで、タブの上下の位置を変更することができます。
開く

図 開くアイコン(タブ)