2. Document Consistency Checker
1
Contents
Document Consistency checker...........................................................................................................2
Introduction...................................................................................................................................2
Scenario 1:..................................................................................................................................2
Scenario 2:..................................................................................................................................2
Features of the document consistency checker (Work-flow system)...............................................2
High Level Project WBS.......................................................................................................................4
Operational Manager’s Schedule.........................................................................................................5
Risk Analysis of the Project..................................................................................................................5
Developer Roles .................................................................................................................................7
SWOT ANALYSIS.................................................................................................................................8
Project Plan......................................................................................................................................13
Milestone 2......................................................................................................................................14
Functional and Non-Functional requirements.....................................................................................14
Functional and Non-Functional requirements prioritised.................................................................14
Alternatives..................................................................................................................................15
Models.............................................................................................................................................17
Database ERD...............................................................................................................................17
Class Diagram...............................................................................................................................18
Use Cases.....................................................................................................................................19
Administrator............................................................................................................................19
Client........................................................................................................................................20
Moderator................................................................................................................................21
Consistency System...................................................................................................................22
Use Case Summary....................................................................................................................23
Sequence Diagrams.......................................................................................................................24
Client Login...............................................................................................................................24
Client Registration.....................................................................................................................25
File Move..................................................................................................................................26
Scenario 1.................................................................................................................................27
Scenario 2.................................................................................................................................28
State Diagram...............................................................................................................................29
User Checker.............................................................................................................................29
3. Document Consistency Checker
2
Admin.......................................................................................................................................30
Moderator................................................................................................................................31
Document Consistency checker
Introduction
Scenario 1:
A user logs into the website, and uploads a document to the website and select a
template of which his document will be outputted.
The website will accept documents of different types, example: doc, txt file, pdf, etc.
The user will receive notifications on the progress of his document.
The server housing the document consistency checker will then check the layout of the
document, do a spell check on the document, fonts and font size check in accordance to
the template selected by the user.
Once the systemis done modifying the document according the specific template
selected, it is then sent to the moderator who will make sure the document meets the
standards. Once they happy with the moderator then gives the thumbs up for the
system to notify the user on the completion.
The user will then login and download the modified document according to the output
selected earlier.
Scenario 2:
A user logs into the system, select a template and the systemwill provide prefilled form
of the template selected.
The user then fills the form and uploads the document to the document consistency
checker.
Also the user can upload multiple document to the system, and notifications are sent to
the user notifying them of the progress of their document.
Same as scenario 1 from step 3 to step 6.
Features of the document consistency checker (Work-flow system)
Features Description
Modelling Forms & Graphical
Representation
Interface to preview a selected template
Document Consistency checker The systemwill take a document, format it
accordingly, spell checks, layouts etc. will all
be taken into consideration
Role Based Access Control Access to different levels of the systemis
4. Document Consistency Checker
3
based on the user’s role. Example: a user
can only upload and select the template
they want to upload. Whiles the moderator
can make changes to a document as it is
been processed.
Workflow Pattern The systemprocesses should work in
harmony, a document is uploaded, a
notification is sent to the user about the
progress of the document.
Prefilled forms Sample forms/ templates will be provided
to the user whereby the user can select a
template of how the document will be
outputted.
SLA status indicators Status indicators are set to show the
progress of the document. Telling the
administrator on the progress of the
document.
Email Notification / Notification Notifications are sent to the administrator
or user based on the progress of the
documents
Integrating Documents The website should be able accept
documents of different file types and
output to different file types.
Reports The systemwill have to create a report on a
document it has processed and write the
changes it has made on that document
5. Document Consistency Checker
4
High Level Project WBS
WBS Phase Name Description
1.0 Initiation The beginning of the project
1.0.1 Develop a
Business Case
This captures the reasoning for initiating a project.
1.0.2 Appoint the
Project Team
A team is selected to solve the project
1.2 Planning The Planning activities container for the project
1.2.1 Create a Risk Plan In this phase the project risks are identified, analysed
and solutions are created for risk found
1.2.2 Overall interface
Design
The overall layout of the project will be designed
1.2.2.1 Front end design The Graphical user interface will be designed in this
phase
1.2.2.2 Database design The Database design developed
1.3 Execution Build the physical project deliverables and present
them to the customer for sign off.
1.3.1 Build Deliverables Design and develop components that should be
completed at specific dates
6. Document Consistency Checker
5
1.3.2 Monitor and
Control
The deliverables of the project is monitored to make
sure that all the deliverables will be completed on
time.
1.3.2.1 Perform Risk
Management
A risk management system will be designed to more
than just identify the risk. This systemwill also quantify
the risk and predict the impact on the project
1.3.2.2 Testing Units, components and deliverable packages will be
tested in this phase to make sure everything works as
plan.
1.4 Closure Project Closure will involve handing over the
deliverables to the customer and passing the
documentation to the business
1.4.1 Review Project In this phase all aspects of the project is reviewed from
the initiation of the project till this stage to evaluate
the quality of the completed project.
1.4.1.1 Final test A final test is done on all the deliverables of the
project.
1.4.1.2 Close Project All documentation, tutorials and the final project is
delivered to the customer and the team is disband.
Operational Manager’s Schedule
Month Managers
June Jaco
July Gordon Roodt & Simon Lepogo
August Johannes van Greunen & Jacques Mare
September Jacques Steyn & Vincentia
October Jaco Coeteze & Gordon Roodt
November Johannes van Greunen & Jacques Steyn
Risk Analysis of the Project
Risk Identified Urgency Visibility Priority or Rank
(1-5)
Proposed
Solution
Web Interfaces
may not be
compatible
with all web
browsers
low Other web
browsers may
not display the
web pages as
we have
designed
1 Give help to the
user on the
supported web
browsers if
need be.
Having to write
part of our
project to use
Medium-High The use of
PowerShell will
allow our
4 Read tutorials
on how to
develop in
7. Document Consistency Checker
6
PowerShell system to
support
different file
types
PowerShell
Learning a new
language which
will be ASP
High Some group
members may
not be able to
code in ASP if
not thought.
5 Prioritize when
group members
need to
understand the
ASAP concept.
Developing a
new system
from scratch
High Without well-
defined
requirements
the project may
not be designed
to solve its
intended
purpose
5 Research on old
systems or
features used
by old systems
and
incorporating it
into our system
Compatible
with different
file types. Doc,
text , pdf etc.
Medium-high A user uploads
a file in a doc
document and
excepts a pdf
output at the
end of the
project
3 By using
PowerShell we
will be able to
this problem. As
it allows the
system
manipulate the
document and
save as the
required
document
Document
consistency
checker
High The logic
needed for the
system to do
spell checks,
reformat a
document, etc.
will be a
challenge as
this is new to all
the group
members
5 Breakdown the
logic of the
consistency
checker and
research
possible
solutions in
solving them.
Group
members not
completing the
set goals on
Medium-high When a goal is
set for each
member there
is a threat that
4 Multiple people
will be tasked
to complete a
goal
8. Document Consistency Checker
7
time. they may not
be able to
complete it on
time.
Communication
over a network,
example :
sending an
email
notification,
uploading a
document from
a different
location to the
server
low There might be
lost of packet
during the
transmission of
data
2 Giving
verification to
users when
their
documents
have been
received.
A group
member may
fall sick when a
presentation is
due
medium 3 Assign 2
monthly
managers for a
milestone. This
will allow any of
the three group
members to
present. As we
share notes and
ideas on the
presentation.
Developer Roles
Task Members Responsible
Project Planning All members
Website design (Frontend design) Jacques Steyn & Vincentia
Database design (backend design) Simon lepogo & Danny Amenigy
Business layer design (backend design) Johannes van Greunen, Jacques Mare &
Gordon Roodt
Website creation (frontend creation) Jacques Steyn, Vincentia & Gordon Roodt
Business layer creation (backend creation) Johannes van Greunen, Jacques Mare &
Jaco Coetzee
Database creation (backend creation) Simon lepogo , Danny Amenigy & Vincentia
Stress testing Jaco Coetzee, Jacques Steyn & Simon
lepogo
Implementation Danny Amenigy, Johannes van Greunen &
Jacques Mare
9. Document Consistency Checker
8
Monitor and control Gordon Roodt, Vincentia & Jacques Mare
SWOT ANALYSIS
Johannes van Greunen –> ISTP-A
Strength Weakness
Good at programming in C# or PHP Loses interest fast
Can work under pressure Bad at designing interface
Good at logical problem solving
Opportunities Threats
Like to have a challenge if it interest me Prefer to work alone
Try to make something work as it keeps
my interest
Can be quite lazy
Lepogo Simon Ntjuke -> INFP
Strength Weakness
Resilient and dedicated to whatever
challenge is brought forth to my attention.
Not a great programmer as I completely do
not understand the full logic at times.
Slacking off has never been one of my
traits
Creating something from nothing is the
concept of coding, this has never been my
favourite thing o do.
Quick analytical skills. Been able to
identify and analyse what information is
needed concerning database
management.
Multitasking between normal school work
and other work will take time for me to
complete. My priorities are not well
defined.
Work well with others, so working in a
large group will be to my advantage.
Opportunities Threats
To learn and acquire new skills to help me
not just with my academic endeavour, but
in the workplace as well and meet and
work well with new people.
Might be hard to give inputs on some
occasions as this project is going to require
a lot of coding, which is not at all my
strongest point, so that in itself might be a
barrier.
Gordon Roodt -> ENTJ
Strength Weakness
Able to cut straight to the chase in any
situation and not be side-tracked by non-
essential issues
May be unable to understand other
people’s needs where these differ from
their own.
10. Document Consistency Checker
9
A propensity for leadership which follows
naturally from the ability tocontrol and
manage real time / real world situations.
May become childishly petulant or angered
when confronted by situations which
require feeling judgements
A “can do ”approach to life which makes
the working environment a positive place
for them
May unwisely assume people’s ideas are the
only right ones and are therefore being fully
implemented by others
A strong regard for positive social and
economic institutions, structure and
government.
May become so engrossed in a plan or
ambition that personal needs and the needs
of others are forgotten
Second regard for positive social and
economic institutions, structure and
government
May take every decision not made in
agreement with their rational beliefs as a
personal rejection
Able to constantly synthesize and adapt
new ideas and concepts into strategies for
business, social, financial or environmental
development
May be easily taken in or manipulated by
others via agreement with their rational
attitudes.
May become obsessed with small
obstructions and difficulties to the
point where the overall plan is
forgotten
Opportunities Threats
A talent for creating great benefits through
the addressing of social justice issues
Tendency to be controlling
A talent for showing others the way to get
past difficulties in their outer life
Tendency to be challenging and
confrontational
Able to know when to stop and take stock
of life and recognize the qualities of the
moment
Tendency to have difficulty listening to
others
The ability to recognize and mediate their
potentials in accord with the expectations
of others
Tendency to make hasty decisions
An approach to life which includes an
awareness of the differences between their
needs and those of others
Can be overpowering and intimidating to
others
Danny Kedem Amenigy -> ISTJ
Strength Weakness
Completely committed to finishing a task I have a strong, compulsive need to do
11. Document Consistency Checker
10
when I place my mind to it things quickly and remove them from my
“To Do List”, and sometimes the quality of
my work is affected
Able to work under pressure. My time management needs to improve to
help me with task completion.
Jack of all trades with regards to IT, from
programming to networks of computers.
A bit nervous when presenting new ideas to
clients or people who don’t have any idea
of the topic. This is due to the fact that I
might be lost in translation.
Opportunities Threats
Acquire as much knowledge as I can find in
this project and experiences of working
with people.
Time span acquire information needed to
develop the project, solve a new problem
from the top and develop a working
prototype with a new language might be a
challenge.
Improves my leadership qualities, as I try
delegate task efficiently and effectively.
Jacques Mare -> ISTP-T
Strength Weakness
Quick learner A bit lazy
Good at maths Like to procrastinate
Easy to get along Not a leader
Good at logic based work Not great at web designing
Opportunities Threats
Able to learn from new people Transportation might be a problem when
the group
Able to meet new people
Vincentia Zwane -> ISFJ
Strength Weakness
Creative, finds strength when it comes to
the look and feel of the projects, Subject
like PHP I find it to be interesting
Numbers, Maths and statistics tend to be
difficult to me, takes a long time to grasp
the concepts
Research, theoretical subjects come easy
to me, retaining the information and doing
research on the topic.
Take things too personal, I tend to have
trouble separating personal and impersonal
situations- any situation is still and
interaction between two people, so any
12. Document Consistency Checker
11
negativity from conflict can carry over from
professional to personal and vice versa
Reliable and Patient, rather than getting
excited about every idea. I am careful and
precise, take a steady approach. Not only
ensure things are done but to the highest
standard I can reach.
Reluctant to change, situations sometimes
needs to reach breaking point in order to
be persuaded by circumstances.
Imaginative and observant, I observe
peoples perspective and use my
imagination to come up with practical
ideas to accommodate their views
Too altruistic, willing let things slide, to
believe that things will get better soon, to
not burden others by accepting their offers
to help.
Loyal and hardworking, Given a little time
my enthusiasm grows into loyalty. I grow
attached to the ideas and group I dedicate
myself to.
Very organised
Opportunities Threats
I recently attended some extra course that
has contributed to the current Business
Intelligence knowledge have it shown me
how the theoretical concepts learnt can be
applied practically.
Being in the group to do a consistency
checker, the project might prove to be
difficult not having any guides on how to go
about it.
Having another Business Intelligence
student in the group will surely benefit me
because will be able to bounce ideas off
them and improve the ideas we come up
with
Having the main modules of Business
Intelligence being done closer to the end of
the year might come as a challenge for
concepts we have to apply in the project.
Jaco Coeteze -> INFP
Strength Weakness
Works well with others Always picks the easiest way to solve a
problem
Can complete a lot of work in a short time Laziness
No afraid to ask for help Really bad at web design
Opportunities Threats
Will be able to learn how to solve certain
problems quickly
One problem solved in the easiest way may
cause other problems
Will be able to express my C# talents in
this project
May rush my work to complete it quickly
13. Document Consistency Checker
12
Really bad at web design this may affect my
place in the project.
Jacques Steyn -> ENTJ
Strength Weakness
Works well with others Normally waits for until the last minute
Works well under pressure Does not always do enough research
Good with web design
Opportunities Threats
Gaining new knowledge when working on
projects
May rush the work to complete it quickly
15. Document Consistency Checker
14
Milestone 2
Functional and Non-Functional requirements
Requirements Classification
Spell Checking. Functional
Upload Files. Functional
Add template to the document. Functional
Email notifications. Non-Functional
Notify user of document progress. Nice to have
Support multiple files per user. Non-Functional
Support different file types. Functional
Should be able to upload additional template. Non-Functional
Change template if document’s template is incorrect. Functional
Download the changed files. Functional
After systemchanges the documents it should send the documents to a
moderator.
Non-Functional
Functional and Non-Functional requirements prioritised
Requirements: Priority: Order:
Functional Requirements:
Must be able to do spelling
checks and correct were it
can correct.
Highest 1st requirement needed.
Must be able to upload a file. Highest 2nd requirement needed.
Must allow the user to
download the changed file.
High 3rd requirement needed.
Must be able to add a
template to the document.
Moderate 4th requirement needed.
Must be able to change the
template if the document’s
template is incorrect.
Low 6th requirement needed.
Should be able to support
different file types.
Moderate 5th requirement needed.
Non-Functional:
Email Notification. High 1st non-functional
requirement.
Should be able to support
multiple files per user.
High 2nd non-functional
requirement.
After the system changed
the documents it should
send the document to a
moderator.
Moderate 3rd non-functional
requirement.
16. Document Consistency Checker
15
Should be able to upload
additional templates.
Moderate 4th non-functional
requirement.
Should be able to download
a clean document with a
template.
Low 5th non-functional
requirement.
Nice to have:
Notify user of document
progress
low Can be done at the end.
Alternatives
Alternatives Effectiveness
Database Alternatives:
MySQL This will be our main database system which
we will be implementing. We will use it
since works on most operating systems and
it supports java. It’s free to use, great
performance, incredible security, scalable
and supports many development interfaces.
Access Microsoft Access is the database software
that provides templates to help you get
started and newly added web databases that
make it easier to track, report, and share
data with others.
Oracle Works on most operating systems except a
few like BSD, Symbian, Amiga OS. Oracle
supports more indexes which might be
effective in our program. Works with
dynamic and static systems. Is highly
reliable program and very feature rich.
Frontend Alternatives:
JQuery Easy to learn, library is built on shorter
easier code. Thus with simple syntax and
open coding standards we can shorten the
time to employ an application or site. Thus if
we don’t have enough time, might use this
as an alternative. Also it easily integrates
with the Visual Studio IDE.
ASP with C# The language is easy to understand and
write, and sometimes faster. With built in
Windows authentication and per-application
configuration, the application is then more
17. Document Consistency Checker
16
safe and secured. This will be our main
frontend.
Business Alternatives:
Java Excellent for developing cross-platform
applications. Vast array of 3rd party libraries
that available to use and have features that
can help us making the template easier to
edit.
30. Document Consistency Checker
29
State Diagram
User Checker
Checker
Home Search Template Viewing
Upload
Edit
Document Viewing
Document Download
New Search
View Own Documents
Back Home New Search
View Template
Download
[Document status =
Finished]
End
Add Document
Edit Document
Saved Edit
Uploaded Document
Document Downloaded
31. Document Consistency Checker
30
Admin
Home
Search Add
Remove
Modify
View Search Results
New Template
New Template
Modify Existing
Template
Remove Existing
Template
Back
Consistency Checker
Start
ConsistencyChecker
+Checklayout()
+Spellcheck()
+FontandsizeCheck()
+upDateStatus()
Check
[Filetype=correcttype]
Re-Check[Status!=Finished]
Notify
+NotifyModerator
Notifies
[Status=Finished]
