DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
DETAILED DESIGN DOCUMENT FOR Admin Site Common Revision: 1.1
Common Admin Part
Page: 1 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
DOCUMENT CHANGE LOG Revision
Date
Author
Type
1.0
2007/09/01
Tam Nguyen
New
1.1
2007/09/19
Tam Nguyen
Update
Description Initial document Define configured constant for max size of uploaded image
8
Define more Function ID
10
Add new default comic search condions and default date/datetime format
14
Define default value of コード combobox of SYS-COM-991 page
19
Add more search condition state <> 9 in comic or related data.
Common Admin Part
Pages
20, 22
Page: 2 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
Table of contents DETAILED DESIGN DOCUMENT FOR Admin Site Common 1. Introduction 1.1 Purpose 1.2 Scope 1.3 Definitions, Acronyms, and Abbreviations 1.4 References 1.5 Overview 2. Development Settings 3. Common Policies 3.1 Input Check 3.1.1 XML Check 3.1.2 Check for Null Value 3.1.3 Character Check 3.1.4 Max Length Check 3.1.5 Date Check 3.1.6 Picture Check 3.1.7 Other Cases 3.2 Display Delete Confirmation Message 3.3 Paging Display Method 3.4 Substitution of Input Sentence Character from Browser 3.5 Exclusive Control 3.6 Character Code of HTML/Database 3.7 Session Data 3.8 Functions ID and Default Authority XML File 3.8.1 Function ID Definition 3.8.2 Define Initial Roles 3.9 Get Login & Access Right Information (SYS-COM-000) 3.9.1 Program Locations: 3.9.2 Process Flow 3.9.3 Input Parameters 3.9.4 Get User Basic and Authority Information 3.9.5 Set User Information to Global Variable 3.9.6 Get Function Authority 3.10 Check Access Right on Screens and Visibility of 承認/差戻 Buttons 3.11 Common header 3.12 Other 3.12.1 Default Search Condition for Comic Data 3.12.2 Default Search Condition for Comic Related Data 3.12.3 Default date/datetime Format in User Interface 4. Common Screens 4.1 Content Code Search Screen (SYS-COM-991) 4.1.1 Program Locations 4.1.2 Check Access Right 4.1.3 Process Flow 4.1.4 Request Parameter 4.1.5 Check If It Is From Valid Called Forms 4.1.6 Check If It Is Firstly Loading 4.1.7 Store Current Data Of Called Form To Session 4.1.8 Searching Content Data Process 4.1.9 Display Process 4.2 File-selection dialog (SYS-COM-992) 4.2.1 Screen specification 4.3 Common Date Pull Down Template (SYS-COM-995) 4.3.1 Generate Data Process 4.3.2 Template Specification Common Admin Part
1 5 5 5 5 5 5 6 7 7 7 7 7 8 8 8 8 9 9 9 9 9 9 10 10 10 11 11 11 11 12 12 13 14 14 14 14 14 15 16 16 16 16 16 17 17 17 17 17 19 20 20 21 21 21 Page: 3 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
5. Common Templates 5.1 Various Template and Configuration Files 5.1.1 Various templates 5.1.2 Transmitting mail and Template list 5.2 Mail template 5.2.1 Test Mail Template 5.2.2 Real Mail Template 5.3 Directory configuration 5.3.1 Storage place of image file 5.3.2 Storage place of special-contents file 5.3.3 Storage place of contents file 5.3.4 Storage place of temporary image file
Common Admin Part
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
22 22 22 22 23 23 24 24 24 24 24 24
Page: 4 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
1.Introduction 1.1Purpose This document describes the detailed design and other factors necessary to provide a complete and comprehensive description of the detail design for Admin Common part of CPS system.
1.2Scope The document affects for Admin Common part of CPS system only.
1.3Definitions, Acronyms, and Abbreviations ICT
Information Communication Technology
BA
Business Automation
N/A
Not applicable
TBD
To Be Defined
CSV
Comma separated value
MG
MediaGalaxy Framework
DNPLib
DNP Library for PHP Programming
CPS
Comic Portal System
1.4References 99_共通_外部設計書_Ver.1.0.3.ppt
1.5Overview Later of the document contains 3 sections: Development Settings The section describes Admin Site Common in overall. Overall Description This section describes screen layout, processing contents of all system functions in details. Detailed Design This section describes relationships, logical models, physical models and detailed definition of tables.
Common Admin Part
Page: 5 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
2.Development Settings All functions/screens in Admin Site have to follow the settings below: Program Language
PHP Perl JAVA ASP Shell Scripts
Type of Program
WEB Program
Using Database
DBM MySQL
Batch Program PostgreSQL
Oracle
Other:
HTML (Select only one option) SJIS JIS EUC UTF-8 CGI (Select only one option)
※Principle of MG is SJIS as default
SJIS JIS EUC UTF-8 ※Principle of MG is SJIS as default Gaiji Processing (Select one option and in case HTML is SJIS only) 1. Required criteria Encoding Settings
Change Gaiji into “〓” (EEFA) Change Gaiji into specified character. Character: Delete Gaiji Using in Windows platform so that Mojibake doesn’t happen. 2. Notice: In case Gaiji occurs, shows Error Message DATABASE (Select only one option) SJIS JIS
EUC UTF-8
※Principle of MG is EUC as default
MG Standard (Change into hankaku the characters: “ & ‘ * , < > ? \ ` | ~ ) Not MG Standard (Can select many options in case it is checked)
CSS Treatment
“ (Double quote)
& (Ampersand)
‘ (Single quote)
, (Coma)
< (Less than)
> (Greater than)
? (Question)
* (Asterisk)
\ (Back slash)
` (Accent)
| (Vertical bar)
~ (Tilde)
Enable HTML tags (Can input characters: < > & “ ‘ ) Other (Describe detailed treatment in Specification Document) Cookie
Enable
Disable
Send mail
Yes
No
Access Personal Information
Yes
No
※Describe particular data is stored in Specification Document
Process Kana Sound Conductings
When Kana check, treat characters such as ー(long vowel) -(minus) ―(dash) ‐(hyphen) Permit
Error
Process Decimal Numbers
Floor
Round Up
Common Admin Part
Other (Require to show) Ceiling
Other (Require to show)
※In case do not show out, Floor Rounding is default
Page: 6 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
3.Common Policies 3.1Input Check 3.1.1XML Check 1.
All the input check rules have to put in XML files and follow defined format of P_XML_Check Library of PHP DNP Libraries (Release 09/2007). XML Template base path for Admin Site: /WWW/DATA/k-comic/xml/System/
2.
The content of item is checked at Server Site then show Error Messages on Input Screen
3.1.2Check for Null Value 1.
In case error occurs for Text-box, the Error Message will be “[Item name]: 未入力です”.
2.
In case error occurs for Pull-Down or Check-Box, the Error Message will be “[Item name]: 未選 択で す”.
3.1.3Character Check テキストタイ プ
入力可 能文 字
入力時、文字チェック前 の変換 処理
入力時 、文 字チ ェッ ク後 の 変換処 理
全角
全角スペース:0x8140 全角数字:0x824F~0x825F 全角大文字アルファベット: 0x8260~0x8279 全角小文字アルファベット: 0x8281~0x829A 全角ひらがな: 0x829F~0x82F1 全角カタカナ: 0x8340~0x8396 "ー":0x815B "・":0x8145 ",":0x8143 "´":0x814C "`":0x814D "‘":0x8165 "’":0x8166 "′":0x818C 全角漢字(JIS の第一・二水準 まで) 全角スペース:0x8140 全角数字:0x824F~0x825F 全角カタカナ:0x8340~0x8396 "ー":0x815B "・":0x8145 ",":0x8143 "´":0x814C "`":0x814D "‘":0x8165 "’":0x8166 "′":0x818C
1)トリミング処理(前後の半 角全角スペースの削除、半 角全角スペースが連続する ものを 1 つにする。) 2)半角スペースを含む半角 文字を全角に変換(半角カ ナの濁点はセットで変換。" ザ"→"ザ") 3)"―"(0x815C) と"‐"(0x815D)と" -"(0x817C)と"─"(0x849F) と"━"(0x84AA)を" ー"(0x815B)に変換
文字チェックの結果、JIS の 第一・二水準以外の文字は" 〓"(0x81AC)に変換して表示。
1)トリミング処理(前後の半 角全角スペースの削除、半 角全角スペースが連続する ものを 1 つにする。) 2)半角スペースを含む半角 文字を全角に変換(半角カ ナの濁点はセットで変換。" ザ"→"ザ") 3)"―"(0x815C) と"‐"(0x815D)と" -"(0x817C)と"─"(0x849F) と"━"(0x84AA)を" ー"(0x815B)に変換 1)トリミング処理(前後の半 角全角スペースの削除、半
文字チェックの結果、JIS の 第一・二水準以外の文字は" 〓"(0x81AC)に変換して表示。
全角カナ
全角文字 Common Admin Part
JIS の第一・二水準
文字チェックの結果、JIS の 第一・二水準以外の文字は" Page: 7 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
全角半角文字
全角は JIS の第一・二水準 半角は 0 と 1~9 と A~Z、a~ z、!"#$%&'()*+,-.:; <>?@[]^_`{|}~
Revision: 1.1
角全角スペースが連続する ものを 1 つにする。) 2)半角スペースを含む半角 文字を全角に変換(半角カ ナの濁点はセットで変換。" ザ"→"ザ") 1)トリミング処理(前後の半 角全角スペースの削除)
http://www.globalcybersoft.com
[email protected]
〓"(0x81AC)に変換して表示。
文字チェックの結果、JIS の 第一・二水準以外の文字は" 〓"(0x81AC)に変換して表示。 半角文字で許可されていない ものは全角に変換可能な文字 は全角に変換、それ以外は半 角スペースに変換。
半角英数字記号
半角英数字 半角英大文字数字 半角英小文字数字 半角英字 半角英大文字 半角英小文字 半角数字
0 と 1~9 と A~Z、a~ z、!"#$%&'()*+,-.:; <>?@[]^_`{|}~ 0 と 1~9 と A~Z、a~z 0 と 1~9 と A~Z 0 と 1~9 と a~z A~Z、a~z A~Z a~z 0 と 1~9
1)トリミング処理(前後の半 角スペースの削除、半角ス ペースが連続するものを 1 つ にする。) 2) 文字スペースを含む文字 文字を半角に変換
1.
In case type of inputted value is not a “half-width alphanumeric charater-symbol” or “half-width alphanumeric character” or “half-width number” after converting, the Error Message is “[Item name] は 「半角英数字」(「半角数字」)で入力してください”.
2.
If a GAIJI character is inputted, it is treated as an error with the following error message: “[Item name]: 外 字が入力されています。”.
3.1.4Max Length Check 1.
To a text field, the number of characters is restricted by max-length of HTML.
2.
If the inputted character is beyond the byte-count of which DB defines then it is treated as an error. Input screen is re-displayed with error message: “[Item name]: ○文字以内で入力してください”.
3.1.5Date Check In case of error, the following error message will be dislayed: “[Item name]: 日付が不正です。”.
3.1.6Picture Check 1.
If size of the uploading picture is too big, the Error Message is “[Item name]: 画像サイズが規定外です ”. The size of picture will be defined in XML Configuration file and named SYS_MAKE_IMG_MAX in bytes unit Ex: SYS_MAKE_IMG_MAX=600 (It means max size of uploaded image is 600 bytes)
2.
If extension of the uploading picture is not JPEG, the Error Message is “[Item name]: JPEG 画像のみ登録 可能です”.
3.1.7Other Cases Other cases will be described in each Detailed Design Document.
Common Admin Part
Page: 8 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
3.2Display Delete Confirmation Message 1.
In case of deletion, a dialog box of JavaScript is displayed with message: “[Number]件削除します”. If “OK” button is clicked, then deletion operation is executed. Otherwise, “Cancel” button is clicked, the dialog is closed.
2.
If there is no Check Box is selected, a dialog box of JavaScript is displayed with error message: “項目名: 選択してください。”.
3.3Paging Display Method When display a list of item: 1.
Display a “maximum item” per page (the “maximum item” number is set on a configure file).
2.
Display the following message on list screen: “該当件数 N 件”.
3.
In case there is more than 1 item which is searched: The number of page is calculate per “maximum item” number which is set before. And, the link to each page is created (example: 1 2 3 4 5).
4.
The link is not created for the current page, it is just set to other pages.
5.
In case there is no item listed, show error message and display neither list-header nor page-link.
6.
Maintenance method of the session when doing searching action: + Search condition is held on session. + Replace item-list when re-search. + When [Clear] button is clicked, session is deleted. + When change from TOP menu, session is deleted as well.
7.
Prepare the “maximum item” number for each screen (this value can be set on a configure file).
3.4Substitution of Input Sentence Character from Browser -
If “new-line” character is inputted on text area, it is also displayed on HTML.
-
If “new-line” character exists in data, which is exported from DB, it will be removed as well.
-
If TAB character is inputted on text area, it is deleted before register into DB.
-
Delete TAB character on confirm screen.
3.5Exclusive Control Exclusive control of DB is not performed
3.6Character Code of HTML/Database -
HTML display character is UNICODE [UTF-8] with Front-End Site and Shift-JIS with Admin Site.
-
Database storing character encoding is EUC.
-
Exchanged Files is in Shift JIS encoding.
3.7Session Data Data area in Session Container have to set in LONGTEXT type necessarily.
Common Admin Part
Page: 9 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
Search condition data will be stored in SESSION container of each function. Each time re-searching, this SESSION area will be replaced. In case User clicks on “クリア” button in Search Screen, Search condition in SESSION wil be deleted. When moving to Admin Main Menu Screen (SYS-MEN-000), all SESSION data which belongs to that function will be cleared.
3.8Functions ID and Default Authority XML File 3.8.1Function ID Definition In all the Function/Screen of Admin Site have to define a FUNCTION_ID constant of Function itself Function ID 01 02 03 04 05 06 07 08 09 10 11-1 11-2 11-3 11-4 11-5 11-6 12 14 15 16 17 18
Function Name Comic Basic Management - コミック基本データ登録管理 Comic Attribute Management - コミック属性データ登録管理 Search Key Management - 検索キーワード類義語設定 Author Management - 著者データ登録管理 Supported Message Management - 応援メッセージ設定管理 Magazine Content Management - 雑誌別コンテンツ設定登録 Magazine Special Content Management - 雑誌別スペシャルコンテンツ入稿管理 Quick Polls Management - クィックポール設定登録 Recommend Management - レコメンド情報設定管理 Ranking Management - ランキング情報設定管理 News Management - ニュース記事情報登録管理 Event Management -イベント情報登録管理 “Rookie of the Year” Management -新人賞募集情報登録管理 Present Management -プレゼント報登録管理 Questionnaire Management -アンケート情報登録管理 Special Contents Management -スペシャルコンテンツ報登録管理 Inquiry Management - お問い合わせ管理 User Management - 管理者の登録管理 Approve for Publishing Comic Data - コミックWEB公開承認機能 Log Statistics –検索ページ、雑誌TOPページのログ集計 Magazine TOP Management - 雑誌TOP目次設定機能 User Indentification -
3.8.2Define Initial Roles Default available functions for each role (1=CP 事務局、2=編集部、3=制作会社) will be defined in XML file. Location of XML File: /WWW/DATA/k-comic/xml/System/user/user_kanri.xml In User Management Function, template of roles will be loaded dynamicly from XML file. XML Template image No. 1 2 4 5 6 7
Tag Name 機能リスト 機能項目 機能 ID 機能名 権限リスト 権限項目
Common Admin Part
Physical Name functions function id name roles role
Kind Tag Tag Attr Tag Tag Tag
Type Text Int(2) Text
NN
Notes
X X X
Page: 10 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
8 9
id function
権限 ID 機能 ID
http://www.globalcybersoft.com
Revision: 1.1
Attr Tag
Int(1) Int(2)
[email protected]
X X
3.9Get Login & Access Right Information (SYS-COM-000) Function is used to check login information and judge the access right of user, then extract data to Global User Information LOGIN_INFO
3.9.1Program Locations: Program path Entry URL Template file
/WWW/PHP/k-comic/System/auth/My_auth_Get_UserInfo_Function.inc -
3.9.2Process Flow BEGIN
Check if User SEQ of Session is existed?
NO
YES user_kanri table
SELECT
Get User Basic and Authority Information
Is there any record? user_authority table
SELECT
NO
YES
Set User Information to Global Variable
Redirect to Admin Login Screen (SYS-LOG-000)
END Get Login User Information Flow
3.9.3Input Parameters No 1
Parameter Name 機能 ID
Common Admin Part
Parameter FUNCTION_ID
Type Number
Notes ID of each function
Page: 11 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
3.9.4Get User Basic and Authority Information Search/Extract data from user_kanri and user_authority to get User Basic Information and User’s Authority Note : Each user who login into system will have the particular authorities and buttons on screen will hidden or appear based on their authorities. Extract condition: No Item Name Table Column Name Cond Value 1 user_kanri user_seq += [user_authority].[user_seq] 管理ユーザ SEQ 2 user_kanri user_seq = [Sesssion].[GLOBAL_USER_SEQ] 管理ユーザ SEQ Note: it must be made as a LEFT JOIN relationship between user_kanri and user_authority tables. Extract items No 1 2 3 4 5 6 7 8 9 10
Item Name 管理ユーザ SEQ 管理ユーザ ID 氏名 所属 権限 雑誌種別 ID 最終ログイン日 全体権限 機能 権限
Table user_kanri user_kanri user_kanri user_kanri user_kanri user_kanri user_kanri user_authority user_authority user_authority
Column Name user_seq user_id name post role mag_id last_login_date authority function sub_authority
Remarks Used to store each time access to DB Used to display on Common Header Used to display on Common Header Used to display on Common Header Used to judge access right of functions
Used to judge access right of functions in details
Check extracting result: No 1 2
Check Result No Record Found Invalid User At least 1 Record Found OK
Description Redirect to Administration Login Screen ( SYS-LG-000 ) Next to Set User Information to Global Variable Process
3.9.5Set User Information to Global Variable Set User Basic and Authority Information into Global Variable $LOGIN_INFO No 1 2 3 4 5
Item Name 管理ユーザ SEQ 管理ユーザ ID 氏名 所属 権限
Element USER_SEQ USER_ID USER_NAME USER_POST USER_ROLE
Assigned Data [user_kanri].[user_seq] [user_kanri].[user_id] [user_kanri].[name] [user_kanri].[post] [user_kanri].[role]
6 7 8
雑誌種別 ID 最終ログイン日 全体権限
USER_MAG_ID LAST_LOGIN AUTHORITY
[user_kanri].[mag_id] [user_kanri].[ last_login_date] [user_authority].[authority]
9
現在機能権限
FUNC_AUTHORITY
Perform Get Function Authority Process and get Returned Value
10
権限情報サブ
AUTH_ARRAY
[user_authority].[*]
Common Admin Part
Notes
1=CP 事務局 2=編集部 3=制作会社 YYYYMMDDHH24MMSS 1=管理者 2=担当者 0=権限しない 1=編集/確認 2=承認 3=全部権限 Sub Array contains Page: 12 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
Authorities Note: In case AUTHORITY = 1 (管理者) then the sub array AUTH_ARRAY is unnecessary to set For each Authority Information (user_authority), assign to elements of AUTH_ARRAY sub array No 1 0.1 1 0.2
Item Name 機能
Program Name Key of Array
Data [user_authority].[function]
Notes Set as key of Array Item
権限
SUB_AUTH
[user_authority].[sub_authority]
1=編集 2=承認
Note: Based on the Function ID of Screen and extracted User Information above, system will detect User’s access right to that screen. However, some screens do not need to check access right, system just check valid user in that screens only. They are: Admin Login Screen (SYS-LG-000), Admin Logout function (SYS-LG-001), Change Password Screen (SYS-PW-001)
3.9.6Get Function Authority Based on authority of Login user ([LOGIN_INFO].[AUTHORITY), Function Authority value will be extracted as login following: 3.9.6.1Login User is Administrator: [LOGIN_INFO].[AUTHORITY] = 1 Get data is defined in Initial Role XML file (user_kanri.xml) Extract condition No 1 2
Item Name 権限 ID 機能 ID
Source user_kanri.xml user_kanri.xml
Tag/Attr [role].[id] [role].[function].[value]
Cond = =
Source user_kanri.xml
Tag/Attr COUNT([role].[function].[value] )
Value [LOGIN_INFO].[USER_ROLE] FUNCTION_ID
Extract items No 1
Item Name 権限ある
Remarks -
Extract result processing No 1 2 3
Searching Result Result = 0 Not access right on the function Result = 1 OK Read File Error Error
Description Set [LOGIN_INFO].[ FUNC_AUTHORITY] = 0 (権限しない) Set [LOGIN_INFO].[ FUNC_AUTHORITY] = 3 (全部権限) Refer to Common Error Screen
3.9.6.2Login User is not Administrator: [LOGIN_INFO].[AUTHORITY] = 2 Get data is extracted in Sub Authority array of Global Login Information (LOGIN_INFO) Extract condition No 1
Item Name 機能
Source AUTH_ARRAY
#key
Element
Source AUTH_ARRAY
Element EMPTY(SUB_AUTH)
Cond =
Value FUNCTION_ID
Extract items No 1
Item Name 権限ある
Common Admin Part
Remarks Page: 13 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
Extract result processing No 1 2
Searching Result Result = True Not access right (Empty) on the function Result = False OK (Not Empty)
Description Set [LOGIN_INFO].[ FUNC_AUTHORITY] = 0 (権限しない) Set [LOGIN_INFO].[ FUNC_AUTHORITY] = [LOGIN_INFO].[AUTH_ARRAY@FUNCTION_ID][ SUB_AUTH]
3.10Check Access Right on Screens and Visibility of 承認/ 差戻 Buttons Almost screens/functions of Admin Site have to check User’s access right at the begin time, except Adminstration Login, Change Password and Main Menu Screen. To check access right, the screen/function have to perform Get Login & Access Right Information process (SYS-COM-000). Based on FUNC_AUTHORITY of Global Login Information $LOGIN_INFO, the access right is acceptiable when $FUNC_AUTHORITY > 0 About functions/screens perform Approve Process, the “承認” or “差戻” buttons will be visible in case FUNC_AUTHORITY = 2 OR 3
3.11Common header Based on Global User Information-LOGIN_INFO gotten from SYS-COM-000 process, template will show User’s Information at the top of each screen (after login)
No 1 2 3 4
Displayed Item Logout ログアウト Go to TOP screen TOP 画面へ Top Image User name
Type Button Button
Parameter Name logout goto_top
Image Label
-
Content Description Link to Logout Page ( SYS-LG-001) Link to Admin Main Menu Screen (SYS-MEN000). Logo of System Show Name of Login User: [LOGIN_INFO].[ USER_NAME]
3.12Other 3.12.1Default Search Condition for Comic Data In case in specification of function is not defined, the conditions below will be included as default conditions: Status (ステータス) of extracted data must be available: status <> 9 (削除) Especially, sort order of serial code in comic_series_mst must be <> 0: comic_series_mst.sort <> 0 According to get data of Preresent Product () must be followed Front-End definitions
3.12.2Default Search Condition for Comic Related Data In case in specification of function is not defined, the conditions below will be included as default conditions: Common Admin Part
Page: 14 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
Status (ステータス) of extracted data must be available: status <> 9 (削除)
3.12.3Default date/datetime Format in User Interface In case in specification of function is not defined, the formats below will be set for date/datetime data: YYYYMMDD → YYYY/MM/DD YYYYMMDD HH:MM:SS → YYYY/MM/DD HH 時
Common Admin Part
Page: 15 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
4.Common Screens 4.1Content Code Search Screen (SYS-COM-991) 4.1.1Program Locations Program path Entry URL Template file
/WWW/Sweb/k-comic/System/common/code_search.php https://www.k-comic.co.jp/System/common/code_search.php /WWW/DATA/k-comic/Template_Base_html/System/common/code_search.html
4.1.2Check Access Right Perform Get User Basic and Authority Information (SYS-COM-000) process to check user’s access right. Check Access Right processing: No 1 2
Check Result [LOGIN_INFO].[USER_SEQ] = NULL Else
Description Redirect to Admin Login Screen (SYS-LG-000) Go to next processes below.
Invalid User OK
4.1.3Process Flow BEGIN
1,Check if it is from valid called forms?
NG
OK SEARCHING
5. Search data from DB according to Search Condition
Is data found?
3.Check if it is loaded at initial time? FIRST LOAD 4.Set current data of caller form in Session
NO
2. Redirect to Admin Main Menu Screen (SYS-MEN-000)
YES 6. Set data of caller form in Session to hidden fields 7. Process output data and show page
END Common Admin Part
Page: 16 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
4.1.4Request Parameter Method: POST No 1 2 3 4
Item Name コンテンツグループ名称 コンテンツ名称 著者名 コード
Parameter Name content_group_name content_name author_name code_type
5
呼び出された画面 URL
caller_url
6
処理イベント
searching
Description It is happened when user clicks on “検索” button. It is happened when user clicks on “検索” button. It is happened when user clicks on “検索” button. 1=品目コード 2=コンテンツコード 3=コンテンツグループコード URL of called screens. It is happened when user clicks on “検索” button. Happen when user clicks on “検索” button. Perform check input and search in
4.1.5Check If It Is From Valid Called Forms At the time init this page (it means page is loaded when user clicks for search code at called page), system will detect if this page is submitted from VALID Called Forms based on $_SERVER[‘HTTP_REFERER’] variable: Check Valid Called Forms processing: No 1 2
Check Result [POST].[searching] = NULL AND $_SERVER[‘PHP_SELF’] NOT IN $_SERVER[‘HTTP_REFERER’] Else
From Valid Called Forms Fail
Action Go to Check if the page is firstly loading Redirect to Admin Main Menu (SYS-MEN-000)
4.1.6Check If It Is Firstly Loading No 1 2
Check Result [POST].[searching] = NULL First Loading Else Fail
Action Go to Store Current Data Of Called Form To Session Redirect to Admin Main Menu (SYS-MEN-000)
4.1.7Store Current Data Of Called Form To Session Delete Session Container of this screen, then store all current data from Called Form via POST data. Session Container named “CURRENT_DATA”. Referer information will be stored in [SESSION][CALLER_URL] variable.
4.1.8Searching Content Data Process 4.1.8.1Input Parameter Check No 1 2
3 4
Parameter Name content_group_name
content_name
Common Admin Part
Check Content Full-width-character check error Length check error: > 255 bytes Full-width-character check error Length check error: > 255 bytes
Error Message/Error Code コンテンツグループ名称:外字が入力されています。 コンテンツグループ名称:255 文字以内で入力してくだ さい。 コンテンツ名称:外字が入力されています。 コンテンツ名称:255 文字以内で入力してください。
Page: 17 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
5 6
author_name
7
content_group_name , content_name and author_name Check result processing: No 1 2
Full-width-character check error Length check error: > 255 bytes Requirement check
Check Result Error_Array is not Error occurs empty Error_Array is OK empty
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
著者名称:外字が入力されています。 著者名称:255 文字以内で入力してください。 [TODO]
Description Collect all Error Messages in Error Content (Error Code) format then go to Display Process Go to Extract DB Process
4.1.8.2Extract Content data from DB Search/Extract condition No 1
Item Name コンテンツ グループ名 称 2 コンテンツ グループコ ード 3 コンテンツ コード 4 コンテンツ 名称 5 品目コード 6 著者コード 7 著者名 8 コッミクの ステータス 9 著者のステ ータス Extract items No 1
Table comic_contentgroup_mst
Column Name content_group_name
Cond LIKE
Value %[POST].[ content_group_name]%
content_group_code
JOIN
[comic_contentgroup_mst].[conte nt_group_code]
comic
content_code
JOIN
[comic_content].[content_code]
comic_content
content_name
LIKE
%[POST].[content_name]%
comic_hinmoku-author comic_hinmoku-author comic_author comic
hinmoku_code author_id author_name state
JOIN JOIN LIKE <>
[comic].[hinmoku_code] [comic_author].[author_id] %[POST].[author_name]%
comic_author
state
comic
Item Name コンテンツグループ コード 2 コンテンツコード 3 コンテンツ名称 4 作品コード 5 作品名称 6 著者名 ORDER BY condition
Table comic_contentgroup_mst comic_content comic comic_author
No Item Name 1 コンテンツグループコード 2 コンテンツコード 3 作品コード Search/Extract result processing No 1
9 (削除)
Column Name content_group_code
Remarks
content_code content_name hinmoku_code title author_name
Table comic_contentgroup_mst comic_content comic
Searching Result Have searched data Data registered
Common Admin Part
<>
9 (削除)
Column Name content_group_code content_code hinmoku_code
Kind of Sort ASC ASC ASC
Description Show search-result in the input screen. Page: 18 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
2
Have no searched data
already Data is not registered yet
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
Show error message: “該当データがありません。”.
4.1.9Display Process 4.1.9.1Screen specification
4.1.9.2Screen Objects No 1
Displayed Item コンテンツ名称
Type Text
Parameter Name content_name
2
著者名
Text
author_name
3 4
検索 コンテンツグループ コード・コンテンツ コード・品目コード
Submit List box
searching -
5
コンテンツグループ
List box
-
Common Admin Part
Content Description Input product name/work name. ■ Input type: [Full-width-character] ■ Initial value: [POST].[content_name] The product name/work name of the record chosen in the Recommendation search screen (SYS-RMD001). ■ Length: 255byte. Input author name ■ Input: [Full-width-character] ■ Initial value: [POST].[author_name] The author name of the record chosen in the Recommendation search screen (SYS-RMD-001). ■ Length: 255byte. Submit to itself in order to perform searching Displayed contents group code/contents code/item code registered into the table comic_contentgroup_mst, comic and comic_content. Displayed contents group name/contents name/item name registered into the table Page: 19 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
6
名・コンテンツ(作 品)名・製品名 著者名
7
選択
8
List box Button
-
コンテンツグループ 名称
Text
contentgroup_name
9
コード
Radio button
code_type
10
呼び出された画面 URL 呼び出された画面の データ
Hidden
caller_url
Hidden
-
11
-
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
comic_contentgroup_mst, comic and comic_content. Display author name which is registered into table comic_author. Perform JS commands to submit to Called Form with POST data includes content_group_code/ content_code/hinmoku_code based on code_type value. Input contents group name ■ Input: [Full-width-character] ■ Initial: [POST].[contentgroup_name] ■ Length: 255byte. Kind of code, which is investigated, is set. * Initial value: Only the kind of code is set ON from called screen. Others are set OFF. Example: A contents code is set to ON when displayed by “contents code being investigated” from a Contents code registration screen. Set by [SESSION][CALLER_URL] It happens in case Searched Data have been found. The [SESSION][CURRENT_DATA] will be located in Hidden fields.
4.2File-selection dialog (SYS-COM-992) 4.2.1Screen specification
No 1
Displayed Item File selection dialog
Common Admin Part
Type File
Parameter Name -
Content Description This dialog is displayed at the time the Page: 20 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Control
Revision: 1.1
http://www.globalcybersoft.com
[email protected]
“Reference” button is pressed. If a file is chosen, the selected file name and the selected pathname will be set to the screen of a calling agency. * In addition to this, it is based on the existing specification.
4.3Common Date Pull Down Template (SYS-COM-995) 4.3.1Generate Data Process -
Create a Year-array with value range is [“Un-chosen”, “current year – 30” – “current year + 1”].
-
Create a Month-array with value range is [“Un-chosen”, 1 – 12].
-
Create a Date-array with value range is [“Un-chosen”, 1 – 31].
4.3.2Template Specification
No 1
Displayed Item Year
Type Combo box
Parameter Name [year]
2
Month
Combo box
[month]
3
Date
Combo box\
[date]
Common Admin Part
Content Description Select a year. ■ Initial value: “<未選択>” ■ Value range: [“current year – 30” – “current year + 1”] Example: Current year is 2007, it displays [1977 - 2008] Select a month. ■ Initial value: “<未選択>” ■ Value range: [1 – 12] Select a month. ■ Initial value: “<未選択>” ■ Value range: [1 – 31]
Page: 21 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
http://www.globalcybersoft.com
Revision: 1.1
[email protected]
5.Common Templates 5.1Various Template and Configuration Files 5.1.1Various templates No 1 2 3
Item Screen (input form) template Mail template Configuration file
Directory /WWW/DATA/
/Template_Base_html/ system/<sub_dir> /WWW/DATA//Template_Base_mail/ system/<sub_dir> /WWW/PHP//define/system/<sub_dir >
Contents Refer to Mail_template for more detail (4.9)
5.1.2Transmitting mail and Template list No
1
A function and processing Manage User registration
Processing New registration completion Password re-issue Sending back comic basic information Sending back contents attribute information Sending back author master information Sending back aid information
3
Comic recognition
4
Registration of comic basic information Registration of contents attribute information Registration of author master information Registration of an aid message
Sending back Ranking
5
Registration Sending back
Recommendation
Common Admin Part
Registration
Destination A magazine management person, registered Manage User Manage User by whom the recurrence line was done Manage User who registered data at the end Manage User who registered data at the end Manage User who registered data at the end In the case of a magazine management person and the edited message, he is Manage User who registered data at the end. Manage User who registered data at the end Manage User who registered data at the end Manage User who registered data at the end In the case of a magazine management person and the edited message, he is Manage User who registered data at the end. Manage User who registered data at the end Manage User who registered data at the end Manage User who registered data at the end Manage User who registered data at the end
File name /user/end_mail.txt /user/pass_mail.txt
/comic/reject_mail.txt
/comic/msg_reject_mail .txt
/comic/accept_mail.txt
/comic/msg_accept_mai l.txt
/ranking/reject_mail.txt /ranking/accept_mail.txt /recommend/reject_mail .txt /recommend/accept_ma il.txt
Page: 22 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Sending back 6
Quick pole
Registration
7
Status managed batch
8
Inquiry
The notice of a status change of comic basic & author information (recognition, change and deletion, secret number of cases) Reply Sending back
9
News event
10
Magazine TOP and a table of contents
Registration Sending back Registration Submission of a manuscript
11
Magazine special contents upload
Registration Sending back
http://www.globalcybersoft.com
Revision: 1.1
Manage User who registered data at the end Manage User who registered data at the end CP secretariat
The general user who asked Manage User who registered data at the end (If setup on a magazine page) CP secretariat Manage User who registered data at the end CP secretariat The user, those [ magazine management ] who turned in the manuscript The user, CP secretariat which turned in the manuscript The user who turned in the manuscript
[email protected]
/poll/reject_mail.txt /poll/accept_mail.txt /batch/status_check_ma il.txt
/inquiry/inquiry_ans_m ail.txt /news/reject_mail.txt /news/accept_mail.txt /magazine/reject_mail.t xt /magazine/accept_mail.t xt /magazine/upload_mail. txt /magazine/accept_mail.t xt /magazine/reject_mail.t xt
5.2Mail template 5.2.1Test Mail Template #Env-From: ○○s@○○.jp From: 講談社コミックプラス事務局 < ○○s@○○.jp > To: <%USER_EMAIL%> Cc: Bcc: Reply-To: Subject: (テスト)コミック基本情報 差戻通知(○○) Content-Type: text/plain; charset="ISO-2022-JP" Mail Tag From To Subject
Common Admin Part
Content Configured parameter Configured parameter (テスト)コミック基本情報 差戻通知
Page: 23 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Revision: 1.1
http://www.globalcybersoft.com [email protected]
5.2.2Real Mail Template #Env-From: ○○s@○○.jp From:講談社コミックプラス事務局 < ○○s@○○.jp > To: <%USER_EMAIL%> Cc: Bcc: Reply-To: Subject:コミック基本情報 差戻通知(○○) Content-Type: text/plain; charset="ISO-2022-JP" Mail Tag From To Subject
Content Configured parameter Configured parameter コミック基本情報 差戻通知
5.3Directory configuration 5.3.1Storage place of image file Picture Real directory
/WWW/DATA//System/kc_u p/image/[each system directory]/<sub_dir>
Symbolic Link (front)
/WWW/Web// kc_up/image/[each system directory]/<sub_dir>
Symbolic Link (management)
/WWW/SWeb// kc_up/image/[each system directory]/<sub_dir>
5.3.2Storage place of special-contents file HTML Interim storage
Before public presentation
After public presentation
/WWW/SWeb//System/SEP/[ number published temporarily]/<sub_dir>
/WWW/SWeb/
/WWW/Web//SEP /[printing magazine classification ID]/[directory specified in the input screen]/<sub_dir>
5.3.3Storage place of contents file HTML Interim storage
Before public presentation
After public presentation
/WWW/SWeb//System/MAG/ [number published temporarily]/<sub_dir>
/WWW/SWeb//System/ MAG/[printing magazine classification ID]/[magazine issuewhich-carries-the-article sequence]/<sub_dir>
/WWW/Web//MA G/[printing magazine classification ID]/[magazine issue-which-carries-the-article sequence]/<sub_dir>
5.3.4Storage place of temporary image file Image Temporary storage
/WWW/SWeb//System/tmp_image// Image file name: System Date & first 4 digits of Session ID: yyyymmddhhmmss****.jpg All the file which are in sub-folders from /WWW/SWeb//System/tmp_image/ will be deleted after 24 hours duration. Common Admin Part
Page: 24 of 25
DETAILED DESIGN DOCUMENT Reference: S0460.0-D-199
Common Admin Part
Revision: 1.1
http://www.globalcybersoft.com [email protected]
Page: 25 of 25