2. 8 décembre 2009 [ANALYSIS REPORT]
Table of content
Functional requirements .......................................................................................................................................3
Data dictionary .......................................................................................................................................................5
Events ..................................................................................................................................................................... 9
Home .................................................................................................................................................................................... 10
Persons ................................................................................................................................................................................. 11
Team .................................................................................................................................................................................... 12
Character 1/2 ....................................................................................................................................................................... 13
Character 2/2 ...................................................................................................................................................................... 14
Caracteristic ........................................................................................................................................................................ 15
Manga .................................................................................................................................................................................. 16
Edition ................................................................................................................................................................................. 17
Chapter ................................................................................................................................................................................ 18
Script / Translation ............................................................................................................................................................ 19
Page Mask .......................................................................................................................................................................... 20
Balloons ............................................................................................................................................................................... 21
Pictures ............................................................................................................................................................................... 22
Square mask ........................................................................................................................................................................23
Volume ............................................................................................................................................................................... 24
Offset ...................................................................................................................................................................................25
Search ................................................................................................................................................................................. 26
Stats .................................................................................................................................................................................... 27
Program interfaces .............................................................................................................................................. 28
Home .................................................................................................................................................................................. 29
Person ................................................................................................................................................................................. 30
Team .................................................................................................................................................................................... 31
Character .............................................................................................................................................................................32
Manga .................................................................................................................................................................................. 33
Edition ................................................................................................................................................................................ 34
Chapter ................................................................................................................................................................................35
Script................................................................................................................................................................................... 36
Page Mask ...........................................................................................................................................................................37
Pictures ............................................................................................................................................................................... 38
Picture mask ...................................................................................................................................................................... 39
Translation editor .............................................................................................................................................................. 40
Volume ................................................................................................................................................................................ 41
Offset .................................................................................................................................................................................. 42
Search ................................................................................................................................................................................. 43
Stats .................................................................................................................................................................................... 44
Conception Choices......................................................................................................................................................................................................45
Project Okatu | Analysis report 2
3. 8 décembre 2009 [ANALYSIS REPORT]
Functional requirements
The following table lists the functional requirements.
The functional requirements are a translation of the customer
requirements into quantifiable terms.
It represents what the final application is expected to do, and what
technical functionality will be implemented to reach this goal.
For each customer requirement, there is at least one functional
requirement defined.
Project Okatu | Analysis report 3
4. 8 décembre 2009 [ANALYSIS REPORT]
Network & Link between
Time & Sync Usage & security Storage
physical space artefacts
Every squares,
The system must
A new manga can only Only registered pages layout, A manga is
be connected
be created if it is users can access to covers, scripts and composed by one or
with a external
uploaded by the client the application translations are more editions
database
stored permanently
A new edition of a A user can only The system can
Every composed An edition is
manga can only be access to the be connected
pages are stored composed by N
created if the manga functions related to with different
permanently volumes
exist their departments databases
A new volume of an All user inputs
Every final offset A volume is
edition of a manga can should be Client Server
are stored composed by N
only be created if the prevented from Architecture
permanently chapters
edition exist SQL attacks
A script is uploaded The validity of the A chapter is
for a volume if the ISBN number is composed by N
volume exist checked pages
The system should
A volume is translated A page is composed
be able to search a
in another language if by N squares and
square containing 1
the volume and the have an attached
or more specified
script associate exist mask
characters
An empty page of a
The system should
volume is uploaded A picture have one
be able to search a
(layout) if a volume associated mask
manga by the name
exist
The system should
A square is uploaded if be able to compute A picture is
the page it belongs sales statistics of a composed by N
exist Volume per edition, bubbles
type or country
A bubble is related
A page mask is created
to a text and a text
if the page layout exist
layout
A square mask is A volume has one
created if the scare and only one
exist language.
A picture is
A cover is composed if
composed by N
the volume exist
characters
A team is
Final offset is
composed by N
generated if the
members
volume is completed
(employees)
Daily backup is
conducted every
Saturday at 7am
Project Okatu | Analysis report 4
5. 8 décembre 2009 [ANALYSIS REPORT]
Data dictionary
The data dictionary represents a raw list of system attributes defined by a
name and a type.
Some of the attributes are technical, such as internal references for a
further usage in a database, and others, called CustomerID, are
information which will be added by the user.
In both case, a short description is provided.
This list has to be exhaustive in order to make sure we will not forget any
aspect of the program.
Project Okatu | Analysis report 5
6. 8 décembre 2009 [ANALYSIS REPORT]
Name Type Category Comments
person_id Int technical person’s reference
person_lastname String CustomerID person’s name
person_firstname String CustomerID person’s first name
person_alias String CustomerID person’s login
person_password String CustomerID person’s password
person_nationality String CustomerID person’s nationality
person_address String CustomerID person’s address
person’s phone
person_phone_number String CustomerID
number
person_mail String CustomerID person’s e-mail
person’s skills
Skill_id int technical (mangaka,
translator…)
Skill_name string technical
team_id Int technical team’s reference
team_name String CustomerID team’s name
name of the function
team_function_name String CustomerID
in a team
Id of a function in a
team_function_id Int technical
team
manga_id Int technical manga’s reference
manga_title String CustomerID manga’s title
Manga’s type
manga_type String CustomerID (shonen, shojo,
seinen…)
count of existing
manga_volume_count Int CustomerID volumes for a manga,
up to today
manga_description String CustomerID
character_id Int technical character’s reference
character_lastname String CustomerID character’s name
character_firstname String CustomerID character’s first name
character’s gender
character_gender String CustomerID
(male, female, other)
Reference to a generic
caracteristic_id Int technical
characteristic
Name of a generic
caracteristic_name String CustomerID
characteristic
Value of a generic
caracteristic_value String CustomerID
characteristic
chapter_id Int technical chapter’s reference
chapter_name String CustomerID chapter’s name
chapter’s number
chapter_number Int CustomerID
(chapter 1, 2 …)
chapter_description String CustomerID
Project Okatu | Analysis report 6
7. 8 décembre 2009 [ANALYSIS REPORT]
picture_id int technical picture’s reference
page’s number where
picture_ page int CustomerID
a pictureis inserted
picture’s order in a
picture_order int CustomerID
page
colour’s type of a
picture_color_type int CustomerID picture (black &
white, colors…)
picture_file CustomerID picture’s file
A flag on each picture
that gives us the
possibility to know if
picture_flag Boolean technical an image is used on
an edition. If it’s true,
we can’t delete this
image.
location where the
picture takes place
picture_location String CustomerID
(used for textual
search)
picture_mask CustomerID Mask file of a picture
balloon_id int technical balloon’s reference
balloon’s type
balloon_type string CustomerID (thinking balloon,
screaming balloon…)
balloon’s order in a
balloon_order int CustomerID
picture
balloon_abscissa int CustomerID abscissa of a balloon
balloon_orderly int CustomerID orderly of a balloon
Text_id Int Technical ID of a balloon’s text
Balloon’s text on a
Text_content String CustomerID
specified language
script_id int technical script’s reference
script’s file if not
script_file CustomerID added through the
script editor
language_name String CustomerID script’s language
ISO code for a
language_id String Technical
language
determinates if the
script added is the
original language in
script_original Boolean technical
order to know which
script will be the base
of each translate
edition_id int technical edition’s reference
edition_name String CustomerID edition’s name
edition_description String CustomerID edition’s description
Project Okatu | Analysis report 7
8. 8 décembre 2009 [ANALYSIS REPORT]
volume_id int technical volume’s reference
volume_title String CustomerID volume’s title, if exists
volume’s official/legal
volume_ISBN_number int CustomerID
number
volume_price float CustomerID volume’s price in USD
volume’s position in a
volume_number int CustomerID
manga serie
volume_description string CustomerID
cover’s file of a
volume_cover CustomerID
volume
fly cover’s file of a
volume_fly_cover CustomerID
volume
page_id int technical page’s reference
page_mask CustomerID mask’s file of the page
square_abcissa int CustomerID abscissa of a square
square_orderly int CustomerID orderly of a square
factor used to resize a
resizing_factor int CustomerID
picture
date of the first
first_edition_date Date CustomerID
edition of a manga
country of the first
first_edition_country String CustomerID
edition of a manga
editor of the first
first_edition_editor String CustomerID
edition of a manga
date of the first
first_edition_date_country Date CustomerID edition of a manga in
a specified country
editor’s address (the
first editor of a
editor_address String CustomerID manga isn’t
necessarily the
current editor)
month of the legal
legal_deposit_month String CustomerID
depot
legal_deposit_year Int CustomerID year of the legal depot
country where is sold
seller_country String CustomerID
a manga
sale number in a
sale_number_country Int CustomerID
country
sale number for a
sale_number_manga int CustomerID
manga
sale number for a
sale_number_volume Int CustomerID
volume
Project Okatu | Analysis report 8
9. 8 décembre 2009 [ANALYSIS REPORT]
Events
The following pages are presenting our list of events.
An event is one of the actions that a user can choose to do with the
application, by clicking a button. Events trigger internal actions that are
transparent to the end-user.
Here is a quick legend of the symbols used in the chart:
Events.
There are 24 in total. All enabled by
the user.
Choices.
Can be questions to the user or
internal checks.
Internal action
These are the action performed
after an event.
The events are grouped by topic and the numbering doesn’t reflect any
order.
On each page there is a short description of the choices that lead us to
choose the associated layout.
By locked, we mean that an element cannot be edited because it is under a
legal deposit.
Project Okatu | Analysis report 9
10. Home Home
Tuesday, December 08, 2009
Do the login and Connection of the
H1
Yes
password exist? member
8 décembre 2009
No
Connection
Error : the login or
the password
don’t exist. Description
The application will be accessible only by authorized
employees.
They have to log in with their name and password.
This authentification allows to keep track of « who
[ANALYSIS REPORT]
did what? » on a Manga.
Does the member DIsconnection of
H2
Yes
is connected? the member
No
Disconnection
Error : the
member doesn’t
connect.
Project Okatu | Analysis report
10
Page 1
11. Persons
Tuesday, December 08, 2009
Persons
List all registered Does the member
EM0 EM1 Create member
No
members already exist?
Yes
List Person
New Person
8 décembre 2009
Em2
Description
Does the name Load existing Save the edited
EM2 The first thing to do in the application is to register
Yes
match a member? Member’s datas member’s data
every employee of the company, in order to assign
them to a Team.
No
Information required are mainly the name and the
Edit Person function of the employee. Others are optionnals,
that’s why we don’t check if every fields are filled.
[ANALYSIS REPORT]
Error : Member
The printer also have to be registered, as a person.
doesn’t exist
Does the name Delete the Does the name
EM3 EM4 View the member
Yes
Yes
match a member? member match a member?
View
No
Delete Person
No
Person
Error : Member
Error : Member
Project Okatu | Analysis report
doesn’t exist
doesn’t exist
11
Page 1
12. Team Team
Tuesday, December 08, 2009
Does the team List all members
T1 Create team T0
No
already exist? of a team
List team
Yes
New team
8 décembre 2009
T2
Does the name Does the team Add member
Does the team T4
Yes
Yes
T2 Edit team match a member? exist? to team
Yes
exist?
No
Add member No
No
Edit team to team
Error : Member Error : team
Error : team doesn’t exist doesn’t exist
[ANALYSIS REPORT]
doesn’t exist
Does the team
T3 Delete team
Yes
exist? Description
Delete
Each manga has a team attached, which is
No
team composed of severals employees and third
persons.
Error : team
doesn’t exist
Project Okatu | Analysis report
12
Page 1
13. Character
Tuesday, December 08, 2009
Does the
List all characters
CH1 character Create character CH0
No
Character 1/2
of the database
already exist?
New
Yes
List character
character
8 décembre 2009
CH2
Does the
CH2 Edit character
Yes
character exist?
Edit
No
Description
character
Error : character
[ANALYSIS REPORT]
Every character must have a profile stored on the
doesn’t exist
database. It permits to search pictures or volumes
where they appears.
Does the
CH3 Delete character
Yes
character exist?
Delete
No
character
Error : character
doesn’t exist
Project Okatu | Analysis report
13
Page 1
14. Character
Tuesday, December 08, 2009
Character 2/2
Does the ID Does the ID
Does the Add character to Does the Delete character
CH4 match a CH5 match a
Yes
Yes
Yes
Yes
character exist? manga character exist? to manga
Manga? Manga?
No
No
Add Delete
No
No
8 décembre 2009
character character
to manga Error : Manga Error : character to manga Error : Manga Error : character
doesn’t exist doesn’t exist doesn’t exist doesn’t exist
Does the picture Does the Add character to Does the picture Does the Delete character
CH6 CH7
Yes
Yes
Yes
Yes
exist ? character exist? picture exist ? character exist? to picture
[ANALYSIS REPORT]
No
No
No
No
Add Delete
character character
to picture Error : picture Error : character to picture Error : picture Error : character
doesn’t exist doesn’t exist doesn’t exist doesn’t exist
Project Okatu | Analysis report
14
Page 1
15. Caracteristic
Tuesday, December 08, 2009
Caracteristic
Does the Does the
Does the Add caracteristic
CA1 caracteristic caracteristic exist
Yes
Yes
character exist? to character
exist? for this character?
No
No
No
Add
caracteristic
8 décembre 2009
Error :
to character Error : character
Caracteristic CA2
doesn’t exist
doesn’t exist.
Edit
caracteristic
to character Description
Does the
Edit caracteristic
CA2 caracteristic exist
Yes
to character Characters have various types of caracteristics,
for this character?
which are not the same from a manga to another.
Edit That’s why we chosed to allow the user to add
No
generics caracteristics.
[ANALYSIS REPORT]
caracteristic
Error :
to character caracteristic
doesn’t exist for
this character.
Does the Delete
CA3 caracteristic exist caracteristic to
Yes
for this character? character
Delete
No
caracteristic
Error :
to character caracteristic
doesn’t exist for
this character.
Project Okatu | Analysis report
15
Page 1
16. Manga
Tuesday, December 15, 2009
Manga
List all available Are the name Is the form
M0 M1 Create the Manga
Yes
Yes
mangas and ID unique? properly filled?
No
No
List Mangas New Manga
8 décembre 2009
Error: Manga Error : Wrong
Already exist values in fields
Does the ID
match an Load existing Save the edited Description
M2
yes
unlocked manga data manga data
Manga?
Every time a new Manga is created, we call the « Add
Manga » event, which create all relative informations on the
No
Edit Manga database.
[ANALYSIS REPORT]
Informations needed are for example:
Error : Manga the manga title,
doesn’t exist or the type (for example: Shônen)
has been locked the team name
The legal deposit
The first edition country and year
A short description
All the characters presents on the manga have to be listed
here.
Does the ID
match an Erase all
M3 Erase all editions Erase the manga If a mistake have been done, an edit is possible.
yes
Yes
unlocked associated data?
Manga?
Finally, if the manga is abandoned, it is possible to erase the
No manga, and all the work related to it.
No
Delete Manga
Error : Manga
Erase only the
Project Okatu | Analysis report
doesn’t existor has
manga
been locked
16
Page 1
17. Edition
Tuesday, December 15, 2009
Edition
List all available Does the Copy the data of
Create from an
E0 Editions for a E1 edition name the selected Create the edition
No
Yes
existing edition?
given manga already exist? edition
No
Yes
List Editions New Edition
8 décembre 2009
Create a blank
E2
edition
Does the edition
Edit the edition
E2 name exist and is
Yes
data
unlocked?
Description
No
Edit Edition
An edition is a set of volumes.
There can be various edition of the same manga, for
[ANALYSIS REPORT]
Error : Edition example:
doesn’t exist or The « First Edition »
has been locked A réedition impoving some drawings
A réedition adding extra pages about characters
A Collector Edition fully colored with even more extras
Since the editions are frequently a simple reedition of a
previous one, it is possible to create an edition based on a
existing one to avoid starting from scratch. The edition will
Does the edition
Erase all thus have the same script, pages, drawings and cover, and
E3 name exist and is Erase all volumes Erase the edition
Yes
Yes
associated data? you will edit only the data needed.
unlocked?
Even if the informations needed are few, there is always a
No way to edit them.
No
Delete Edition
Finally, if an Edition is locked, neither editing or deleting is
Erase only the possible, and it applies to the Chapters, Scripts,
Error : Edition edition Translationsn, Pages and pictures included on the edition.
doesn’t exist or
Project Okatu | Analysis report
has been locked
17
Page 1
18. Chapter
Tuesday, December 15, 2009
Chapter
Does the
Do the pages
CP1 chapter Create chapter S1
No
Yes
exist?
already exist?
No
New
Yes
Add script
chapter
8 décembre 2009
Error : the pages
CP2
don’t exist
Does the team
Do the pages
CP2 exist and is Edit chapter
Yes
Yes
exist?
unlocked?
Edit
No
No
Chapter
Error : chapter
Error : the pages
[ANALYSIS REPORT]
doesn’t exist or Description
don’t exist
has been locked
A chapter is composed of various pages, and is
included on a volume.
The chapter number is required, others
Does the chapter informations like chapter title and description are
CP3 exist and is Delete chapter
Yes
optionnal.
unlocked?
Delete
No
Chapter
Error : chapter
doesn’t exist or
has been locked
Project Okatu | Analysis report
18
Page 1
19. Script / Translation
Tuesday, December 15, 2009
Yes
Does the
Is it an original
ST1 linked Chapter Use a XML file? Save the file
Yes
No
script
Yes
exist?
Script / Translation
New Script or
No
No
Translation
8 décembre 2009
Error : Chapter Display the
doesn’t exist translation editor Description
The script is provided for each chapter in a XML
file to be parsed and eventually translated.
Once a script is uploaded, it provides the text for
Does the every bubbles of any kind in the chapter.
translation Load existing Save the edited
ST2
Yes
exist and is translation data translation data The translator can now start to translate picture by
unlocked? picture
Of course, translating a whole volume takes time,
[ANALYSIS REPORT]
No
Edit translation that’s why it will be possible to save the working
translation to continue it later.
Error : translation
doesn’t exist or If the manga will finally not be selled in a country,
has been locked the translation can be dropped
Does the
Erase the List all translations
translation
ST3 translation or ST0 available for a
Yes
exist and is
script volume
unlocked?
No
Delete script or List Translations
translation Error : Translation/
Script doesn’t
Project Okatu | Analysis report
exist or has been
locked
19
Page 1
20. Page Mask
Tuesday, December 08, 2009
Page Mask
List all pages for a
P0
given Volume
8 décembre 2009
List Page
Description
Load existing Save the edited
P1 Upload image Fill coordinates
mask’s data the page mask
After uloading a Page, the Graphic Adaptator
need to specify for each locations, their order,
New page and their geometry.
The geometry of the location is the
coordinates of the 4 points composing it, in a
the case of a quadrilateral, of the 3 points in
the case of a triangle.
[ANALYSIS REPORT]
Since every page must have a mask, it is not
Does the page Load existing Save the edited allowed to directly erase a mask from a page,
P2
Yes
exist? mask’s data the page mask only to edit it.
Edit Page Mask
No
Error Page doesn’t
exist
Project Okatu | Analysis report
20
Page 1
21. Balloon
Tuesday, December 15, 2009
Balloons
Does the Add balloon to the
B1
No
balloon exist? database
Yes
Add
8 décembre 2009
balloon
B2
Does the Description
balloon exist
B2 Edit balloon
Yes
and is
unlocked?
Balloon : represents thoughts and speechs of the
No
Edit characters.
There is no text inside, because it will be filled with
balloon Error : Balloon the cntent of the script.
[ANALYSIS REPORT]
doesn’t exist or
has been locked
Does the
balloon exist
B3 Delete balloon
Yes
and is
unlocked?
No
Delete
balloon Error : Balloon
doesn’t exist or
has been locked
Project Okatu | Analysis report
21
Page 1
22. Pictures
Tuesday, December 15, 2009
Pictures
Add Characters Is the form filled
I1 B1 Save the square
Yes
form properly?
8 décembre 2009
No
New Square and Add balloon
picture upload Description
Error : Wrong
values in fields
The main event of the application is the upload of
a square, wich is the drawing that will be cut and
placed in one of the locations of a page.
If we need to delete an image, the associated
mask is erased too.
[ANALYSIS REPORT]
Does the picture
I2 exist and is not Erase mask ? Erase mask Erase picture
Yes
Yes
locked ?
Delete picture No
No
Error : picture
doesn’t exist or
has been locked
Project Okatu | Analysis report
22
Page 1