MOGOK基本設計書

Size: px

Start display at page:

Download "MOGOK基本設計書"

きゅうたさどひら
7 years ago
Views:

1 Regional SNS クラウド対応化基本設計書株式会社ネットワーク応用通信研究所 2011 年 10 月 20 日

2 目次 1. はじめに追加予定機能ファイル倉庫概要機能要件イベント告知概要機能要件 Wiki 概要機能要件非実装項目共有ブックマーク概要機能要件メール通知概要機能要件退会申請概要機能要件 Remember me 概要機能要件 i

3 1. はじめに本文書では OPAL SNS( の基盤となっているオープンソース (MIT License) の SNS システム Regional SNS についてクラウド環境上で広く利用できるような機能追加や既存機能の修正を行うための基本設計を示す以降本文書中では上記プロジェクトを指して本プロジェクトと呼称する 2. 追加予定機能本プロジェクトでは以下の機能を Regional SNS に追加する機能名称概要ファイル倉庫 SNS 参加ユーザー間で任意のファイルを共有しグループ単位ユーザー単位でアクセス制限を掛けられる簡易ストレージサービスを供給するイベント告知現状個人のスケジューラーとしてしか機能していないスケジュール機能を拡張し任意のフレンドに対して任意のイベントへの招待告知を行えるサービスを供給する Wiki SNS 全体の共通 Wiki システムを供給する共有ブックマーク SNS メンバーが興味を持った URL をシステム全体で共有しメンテナンスできるシステムを供給するブックマークに対するコメント投稿 URL 変更に対する修正機能などを提供する 2

4 また SNS システムの基本機能に対する強化として以下を実装する機能名称概要メール通知ブログコメントや新規メッセージコミュニティ掲示版の新規投稿など SNS ユーザーに関連のある新規情報が登録された際にシステムからメール通知する機能を供給する退会申請現状システムからの退会はシステム管理者へメッセージ等で依頼して行ってもらうしかないため個々のユーザーから退会申請を行えるユーザーインターフェイスを供給する Remember me 現状ブラウザを閉じるとログイン情報は失われ再接続時には毎回再ログインを求められるため Remember me 機能を設定しログイン情報を維持できるようにする 3

5 2.1. ファイル倉庫概要本機能は SNS ユーザー毎に一定の容量のディスクスペース ( 上限容量 ) を割り当てその範囲内において任意のファイルをサーバに保管できるようにするアップロードしたファイルは個別にアクセス制限を掛けられるようにする本機能は RegionalSNS のプラグインとして実装されシステム構築時に使用不使用を選択可能なものとする機能要件本機能は UI として以下の各サブ機能を備えるものとするファイル一覧システムに登録されておりログイン中ユーザーが閲覧権限を持つ全てのファイルを一覧表示できること個々のファイルは以下の属性を保持することファイル名カテゴリ説明 ( ファイルに関する補足説明事項 ) ファイルサイズ登録日時更新日時ファイル名カテゴリのいずれかの情報でファイルの検索が可能であること任意の属性を基準として昇順降順のソートができること各ファイル毎にファイル更新画面へ遷移するリンクとファイル削除用のリンクを備えることファイル登録画面へ遷移するリンクを備えること任意の件数でページネーション表示ができること 1 ページの表示件数は個々のユーザーの個人設定から変更可能であることファイル登録ファイルアップロード用のフィールドを 1 つ備えることカテゴリ説明内容を登録するためのフィールドを備えることカテゴリ管理画面へのリンクを備えること登録ボタンの押下によって最終意思確認用のダイアログを表示した上でファイル登録が出来ること 4

6 当該ファイルへアクセス可能ユーザーを指定するための UI を備えることアクセス権の設定方法はアクセス可能ユーザーとアクセス権限の組み合わせを登録する形とするアクセス可能ユーザーの指定は全てのユーザー特定のユーザー ID の 2 種類が利用可能とするアクセス権限は読み取り専用とフルアクセス ( 更新削除も可能 ) の 2 種類とするファイル更新既存ファイルについてカテゴリ及び説明情報の更新用フィールドを備えること更新ボタンの押下によって最終意思確認用のダイアログを表示した上でファイル情報の更新が出来ること当該ファイルのアクセス可能ユーザー情報を変更するための UI を備えることファイル削除ファイル一覧画面の各ファイル情報からリンクされ最終意思確認用のダイアログを表示した上でファイルの削除が出来ること共通各機能はいずれもログイン中ユーザーが処理対象ファイルに対する適切なアクセス権限を保持していることを確認した上で実行可能であることカテゴリ管理現在登録済みのカテゴリ名の一覧を表示できること個々のカテゴリレコードに対してカテゴリ更新カテゴリ削除へのリンクを保持すること新規カテゴリ登録画面へのリンクを備えること新規カテゴリ登録新規カテゴリ情報を登録するためのフォームを備えること 1 件のカテゴリ情報は以下の属性を備えるものとするカテゴリ名カテゴリ説明登録日時更新日時登録ボタンの押下により最終意思確認ダイアログを表示した上で登録処理を行えること 5

7 カテゴリ更新既存のカテゴリ情報 1 件を更新するためのフォームを備えること更新ボタンの押下により最終意思確認ダイアログを表示した上で更新処理を行えることカテゴリ削除既存のカテゴリ情報 1 件を削除できることバリデーション条件ファイル情報項目名ファイル名カテゴリ説明ファイルサイズ所有者登録日時更新日時バリデーション条件 VARCHAR 型 255 バイト以内必須 Category モデルへの外部キー TEXT 型 4096 文字以内 INT 型最大値はシステム側で設定 User モデルへの外部キー DATETIME 型 DATETIME 型カテゴリ情報項目名カテゴリ名カテゴリ説明投稿日時更新日時バリデーション条件 VARCHAR 型 255 バイト以内 UNIQUE 制約必須 TEXT 型 4096 文字以内 DATETIME DATETIME 6

8 2.2. イベント告知概要本機能は RegionalSNS のスケジュール機能を拡張しログイン中のユーザーが招待可能なユーザー ( フレンドもしくは所属コミュニティメンバー ) に対してイベントへの招待を行える機能である招待主であるユーザーは前述の範囲に含まれる任意の数のユーザーに対して告知したいイベントの情報を含めた招待メッセージを通知することができる招待メッセージを受け取ったユーザーのスケジュールカレンダーには当該イベントの開催日に自動的に招待情報が登録されスケジュールカレンダーの UI から当該イベントに対する出席可否の返信が行える機能要件本機能は UI として以下の各サブ機能を備えるものとする新規イベント告知作成スケジュールカレンダー画面に張られたリンクから遷移し新規イベント告知を送信するための作成フォームを表示することイベント告知情報は以下の項目を備えることイベント名主催者日時場所招待者 ( 複数登録可能 ) 招待者は以下の方式のいずれかで選択できるフレンド一覧からユーザー ID を指定所属するコミュニティ名を指定 ( 当該コミュニティの全メンバーに通知 ) 送信ボタンの押下によって最終意思確認用のダイアログを表示した上でイベント情報を各招待者のスケジュールカレンダに登録し招待メッセージを送信出来ること 7

9 イベント招待確認スケジュールカレンダー画面において既存の登録済みスケジュール情報と区別が付く表記で招待イベントがあることを示す表示ができること招待イベントが未処理 ( 内容の表示が一度も行われていない状態 ) である場合その事実が確認できるような UI 上の区別がなされていること一度内容を確認した招待イベントには出欠の確定処理をしていなくても未処理状態を示す表記は行わないこと招待イベントを表すシンボルのクリックによってイベント詳細画面へ遷移することイベント一覧スケジュールカレンダー画面に張られたリンクから遷移しログイン中のユーザーに関わる ( 自身が招待主のイベント / 自身が招待されているイベント ) の一覧表示を行えること個々のイベント情報から当該イベントに関するイベント詳細画面へ遷移できることイベント名主催者日時場所のいずれかをキーワードとしてイベント情報の絞り込み検索ができること各イベントの招待人数と出席者 / 欠席者数が表示されることイベント詳細イベントに対する出席 / 欠席の判断を行うラジオボタンを備えることラジオボタンが選択された場合最終意思確認ダイアログを表示した上で出席 / 欠席情報を確定すること確定結果が欠席の場合当該招待情報を抹消しスケジュールカレンダーから表示されないようにすること当該イベントに結び付いた全ての情報が一括表示できることバリデーション条件イベント告知情報項目名イベント名主催者日時場所バリデーション条件 VARCHAR 型 255 バイト以内必須 User モデルへの外部キー DATETIME 必須 VARCHAR 型 255 バイト以内必須 8

10 2.3. Wiki 概要本機能は SNS システム全体で共有される Wiki ページを供給する SNS 参加ユーザーは原則全員に編集権が与えられ非 SNS ユーザーからは参照のみが行えるものとする編集権の与奪はシステム管理者によって行われ規約マナー等に違反したユーザーから編集権を剥奪することが可能とするまたページ毎に非ログインユーザーへの公開非公開を制御できるものとする機能要件本機能は UI として以下の各サブ機能を備えるものとする Wiki トップページメインメニューからリンクされるトップページであり本ページだけは誰にも削除することができないものとする全ての Wiki ページのルートとして働く Wiki 管理 Wiki 全体の管理画面であり本画面へはシステム管理者のみがアクセスできる以下の各情報を編集するフォームを備えるブラックリスト情報 (Wiki 編集権を剥奪するユーザー ID の一覧 ) Wiki 全体の名称ページ編集個々のページに関する編集画面でありシステム管理者もしくは当該ページの作成者のみがアクセスできる以下の各情報の編集が行えるページ内容 (Wiki 文法に沿ったテキスト ) ページの公開 / 非公開情報ページ削除個々のページを削除する機能でありシステム管理者もしくは当該ページの作成者のみがアクセスできるページ削除の最終意思確認ダイアログを表示し OK が選択された場合にページを削除する 9

11 各ページ共通全てのページは以下の要素を共通して備えるページ編集リンク ( 権限を有する場合のみ ) Wiki 管理リンク ( 権限を有する場合のみ ) ページ削除リンク ( 権限を有する場合のみ ) 新規ページの作成は既存ページに新しくリンクを作成し当該リンクをクリックした際に該当するページ情報が無い場合自動的に新規ページ作成と判断される新規ページ作成の UI はページ編集の UI と同一とする非実装項目以下の機能は今回の作業では実装しない添付ファイルの登録機能ページに対するコメント投稿機能 10

12 2.4. 共有ブックマーク概要本機能は SNS 参加ユーザー間で気になるブックマークを登録し合い SNS システム全体で共有できるブックマーク集を作成する機能であるブックマークされた URL に対しては SNS ユーザー間でコメントを投稿し合うことができる機能要件本機能は UI として以下の各サブ機能を備えるものとするブックマーク一覧登録済みのブックマークを一覧表示できることブックマークはカテゴリにより分類できることカテゴリ情報は 1 件のブックマークに対して複数設定できること個々のブックマークは以下の属性情報を持ち一覧表示に反映できることブックマークタイトル URL 説明文投稿者投稿日時更新日時各ブックマーク毎のコメント数が表示できることブックマークタイトル URL 投稿者のいずれかの情報をキーワードとして検索による絞り込みができること検索は単一キーワードで正規表現検索に対応すること新規ブックマーク登録ブックマーク編集ブックマーク削除の各リンクを備えることカテゴリ管理画面へのリンクを備えること個々のブックマークタイトルをクリックすることでブックマーク詳細画面に遷移できること 11

13 新規ブックマーク登録 1 件の新規ブックマーク情報を登録できるフォームを備えること登録ボタンの押下によって最終意思確認のダイアログを表示し OK が選択された場合に該当ブックマーク情報を保存してブックマーク一覧画面に遷移することブックマーク編集 1 件の既存ブックマーク情報を編集できるフォームを備えることカテゴリ管理画面へのリンクを備えること更新ボタンの押下によって最終意思確認のダイアログを表示し OK が選択された場合に該当ブックマーク情報を保存してブックマーク一覧画面に遷移すること本機能はシステム管理者及び投稿者のみがアクセス可能とすることブックマーク削除最終意思確認のダイアログを表示し OK が選択された場合に該当ブックマーク情報を削除してブックマーク一覧画面に遷移すること本機能はシステム管理者及び投稿者のみがアクセス可能とすることブックマーク詳細個々のブックマークの全属性情報を一覧できること当該ブックマーク情報に対する新規コメントの投稿フォームを備えること当該ブックマーク情報に対するコメントを一覧表示できること個々のコメントに対してシステム管理者ブックマーク投稿者コメント投稿者のいずれかに該当するユーザーはコメント削除リンクをクリックすることで当該コメントを削除できること 1 件のコメントは以下の情報で構成されることコメント本文コメント投稿者名コメント投稿日時コメント本文は Plain Text 形式で表示されること 12

14 カテゴリ管理現在登録済みのカテゴリ名の一覧を表示できること個々のカテゴリレコードに対してカテゴリ更新カテゴリ削除へのリンクを保持すること新規カテゴリ登録画面へのリンクを備えること新規カテゴリ登録新規カテゴリ情報を登録するためのフォームを備えること 1 件のカテゴリ情報は以下の属性を備えるものとするカテゴリ名カテゴリ説明登録日時更新日時登録ボタンの押下により最終意思確認ダイアログを表示した上で登録処理を行えることカテゴリ更新既存のカテゴリ情報 1 件を更新するためのフォームを備えること更新ボタンの押下により最終意思確認ダイアログを表示した上で更新処理を行えることカテゴリ削除既存のカテゴリ情報 1 件を削除できることバリデーション条件ブックマーク情報項目名ブックマークタイトル URL 投稿者投稿日時更新日時バリデーション条件 TEXT 型 300 文字以内必須 TEXT 型 4096 文字以内必須 User モデルへの外部キー DATETIME DATETIME 13

15 カテゴリ情報項目名カテゴリ名カテゴリ説明投稿日時更新日時バリデーション条件 VARCHAR 型 255 バイト以内 UNIQUE 制約必須 TEXT 型 4096 文字以内 DATETIME DATETIME コメント情報項目名コメント本文コメント投稿者名コメント投稿日時バリデーション条件 TEXT 型 4096 文字以内必須 User モデルへの外部キー DATETIME 14

16 2.5. メール通知概要本機能ではブログコメントや新規メッセージコミュニティ掲示版の新規投稿など SNS ユーザーに関連のある新規情報が登録された際にシステムからメール通知する機能を供給するメール通知対象は各ユーザー毎の個人設定編集画面で編集できるようにする機能要件本機能は UI として以下の各サブ機能を備えるものとする個人設定編集既存の個人設定編集画面にメール通知する対象の項目を増設し以下の各イベントに対してメール通知を ON/OFF 指定できるようにすることブログコメント ( 自分の投稿に対するコメントがあった場合 ) 新着ブログ記事新着メッセージコミュニティ掲示版の新着メッセージ各イベント発生時にメール通知条件に合致する全ユーザーに対してメールを配送すること配送されるメールは以下の様式を備えることタイトル ( どのイベントに関する通知か判別できること ) 本文 ( 任意フォーマットイベント内容についての概要的文言 ) 15

17 2.6. 退会申請概要本機能では一般ユーザーが SNS サービスからの退会を行うインターフェイスを供給する現状 RegionalSNS では退会処理はシステム管理者による一元管理下にあり個々のユーザーが自発的に退会する UI が存在しないため本機能により前記機能をシステムに追加する機能要件本機能は UI として以下の各サブ機能を備えるものとする個人設定編集既存の個人設定編集画面に退会申請リンクを追加すること同リンクのクリックで退会画面へ遷移すること退会退会実行の確認メッセージを表示すること本メッセージはシステム管理者によって編集可能であること退会実行ボタンを配置しクリックされることにより最終意思確認用ダイアログを表示し OK が押下された場合退会処理を実行する退会処理に伴いユーザーアカウントの削除が行われフレンド関係など関連情報が消去されることシステム管理既存のシステムの設定編集画面のフォームに新たに退会者へのメッセージ欄を増設しここで設定したメッセージが退会画面に反映すること 16

18 2.7. Remember me 概要本システムのログイン画面に Remember me チェックボックスを増設し同チェックを ON にしてログインした場合ブラウザを閉じてもログイン情報を記憶するように機能修正する機能要件本機能は UI として以下の各サブ機能を備えるものとするログイン画面 Remember me チェックボックスをログインフォーム下部に増設すること同チェックが ON の状態でログイン処理がされた場合ログイン情報をセッションに記憶させブラウザを閉じて再度本システムへアクセスした場合ログイン状態を維持して再表示できること 17

掲示板の閲覧掲示板の閲覧登録権または参照権のある掲示板グループの掲示版を閲覧することができます各利用者の権限は管理者によって設定されます掲示板を閲覧する 1 掲示板画面を表示し閲覧する掲示が含まれている掲示板グループ掲示板の順にクリックします掲示板画面の表示方法ポータル画面の画面説

掲示板の閲覧掲示板の閲覧登録権または参照権のある掲示板グループの掲示版を閲覧することができます各利用者の権限は管理者によって設定されます掲示板を閲覧する 1 掲示板画面を表示し閲覧する掲示が含まれている掲示板グループ掲示板の順にクリックします掲示板画面の表示方法ポータル画面の画面説この章では掲示板の利用方法などについてご案内しています掲示板には文書を登録したり返信を書き込むことができます掲示板グループや掲示板は管理者によって登録されます掲示板の閲覧 140 掲示板の検索 146 掲示内容を転送する 148 掲示内容の登録 151 掲示内容をメールで登録する 158 掲示板の登録予約 159 掲示板の設定 163 掲示板の閲覧掲示板の閲覧登録権または参照権のある掲示板グループの掲示版を閲覧することができます