Thanks to visit codestin.com
Credit goes to www.scribd.com

0% found this document useful (0 votes)
23 views20 pages

Sample 3

The document outlines how eaDocX™ integrates with Enterprise Architect to generate professional documents, specifically focusing on the GetLost project, a travel aggregation service. It includes project background, organization structure, and competitor analysis, detailing features like the TravelOptimizer™ software and TBML standard for travel information exchange. The document also highlights the use of Word styles for formatting and the dynamic generation of content from the EA model.

Uploaded by

idreesali0990
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
23 views20 pages

Sample 3

The document outlines how eaDocX™ integrates with Enterprise Architect to generate professional documents, specifically focusing on the GetLost project, a travel aggregation service. It includes project background, organization structure, and competitor analysis, detailing features like the TravelOptimizer™ software and TBML standard for travel information exchange. The document also highlights the use of Word styles for formatting and the dynamic generation of content from the EA model.

Uploaded by

idreesali0990
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 20

(c) eaDocX Ltd 2012

Get Lost!
A Document which shows how eaDocX™ can be used with
Enterprise Architect Comment [I1]: This is the
only text in this document which
is added manually.

Document: Sample #1 Comment [I2]: This shows


the start of an eaDocX 'Section'. It
is not visible in the final
document, as it's text style is
Sample 1 - Project Overview 'invisible'. It can be see here
Document file name because we have chosen the
- FINAL.docx
Word option to 'show invisible
Change mark date 29/04/2012 text'.
Comment [I3]: This section is
a 'Document Information' one. It
is refreshed each time the
document is generated, so it is
Generated on Author Repository always up-to- date

Some of the information is


Z:\2 - GetLost Project Example and Documents\Get Lost Project
30/04/2012 eaDocX Sales created as the document is
Example.eap generated, some is stored in
eaDocX, and some comes from
the Word document's properties.

Category Comments File As with all eaDocX sections, what


appears here is configurable.
Shows the main formatting options, including new C:\Users\Ian\Documents\7 -
FINAL
V3.0 features like H&V tables and Word Table styles eaDocX Training

Comment [I4]: This is the


end of the eaDocX section.
Any text which you add after this
point will NOT be overwritten
when the document is re-
generated, so you can mix EA and
manual content.

1
(c) eaDocX Ltd 2012

Comment [I5]: We've


decided not to have any manual
content in this document, so
we're straight on to another
eaDocX Section.

2
(c) eaDocX Ltd 2012
Comment [I6]: We have
chosen to start this section with a
1 Project Background Heading Level 1. This is
configurable. There is a page
This section has some general information about the project - why we're doing it, who our main break before this heading, as
competitors will be, and the main people who are involved plus their roles. that's what the Heading 1 Word
style says.
Contains:
eaDocX uses the Word style to
 Intro text determine the detailed formatting
 Organisation of most of the document: the
 Competitor analysis colour of text, font, size,
positioning etc.

So, the generated text can look


exactly the same as the manually
created content: this makes the
document look professional, and
is easier to read.

Comment [I7]: This text has


come from our EA model.
We keep even textual content like
this in EA, because we've found
that it's reused in many
documents, so we have just lots of
background information, which
gets used in many documents.

3
(c) eaDocX Ltd 2012
Comment [I8]: Another page
1.1 Introduction break here, because the Word
Document Heading 2 Style also is
GetLost ™ is a new way to organize and book travel. configured for 'Page Break before'.

Today, there are hundreds of websites offering to book just flights, or just trains, or just cars. A few
will let the customer book a flight AND a hotel. But most customers don't want to travel from an
airport to another airport - they want to travel from home to their destination - an office, or a
beach.

GetLost ™ allows them to do this. They tell the system where they want to start, where they want
to finish, and some options. GetLost ™ will then give them options, based on the customers chosen
criteria.

For example:

 Starting at Bath, UK
 Ending at a hotel near the Arc de Triomphe, Paris Comment [I9]: Bullet points
 Staying - 2 nights in a 3* within text can use their own
Word Style. In this case, we've
hotel Get Lost might produce: chosen one which makes the text
quite compact, and indented. All
Option 1: Cheapest:
this is configured in Word.
1. Car from home to London, Heathrow (estimate GBP 34.00)
2. Park in Business Parking - GBP 45.00
3. Flight LHG-CDG - GBP 234.00
4. Metro CDG - Paris - GBP 12.00
5. Hotel Le France, 1 person, 2 nights, half board GBP 240. 00 Comment [I10]: Numbered
lists can also use their own Word
Option 2: Greenest style.
1. Bus from (home) to Bath railway station **
2. Train to London Paddington
3. Tube to St. Pancras
4. Train to Gare du Nord (Paris)
5. Metro to hotel
6. Hotel Le France, 1 person, 2 nights, half board GBP 240.00
** - not sure yet how we will express the 'green-ness of each part of the journey: either tonnes of
CO2, or perhaps a simpler 'starring' system: 5* = very green, 1* = not.
Option 3: Fastest

...etc

For each leg of the journey, the customer will be able to ask for other alternatives e.g. Taxi from
home to the train station.
Business Case

Like other travel aggregators, GetLost will make a margin on each journey booked, which will be
enhanced by doing deals with specific providers who will give us discounts, which we may pass on
part of to the customer.

GetLost ™ is made possible by two recent innovations:

4
(c) eaDocX Ltd 2012
1 - A unique, patented piece of software - TravelOptimizer™ - that compares modes of transport
to produce the best customer solution. It's a bit like the travel directions software that motoring
companies use, except multi-modal.

“Best” can be based on

 Cheapest
 Fastest
 Lowest carbon-footprint
This is not where we will make the money (quotes are free) – the profit comes from the
commissions on booking hotels etc, but the multi-model quote is what we believe will make people
keep using the site, especially the carbon footprint feature. TravelOptimizer keeps a database of
maps, travel routes, possible costs (not quotes, just general rates for typical journeys) from many
TBML suppliers.

2. A new XML-based international standard for exchange of travel information & quotes and
payment of fees: TBML, managed by TBMLCo. This makes integrating new travel service suppliers a
simple, non-IT process, removing the need for aggregators like SABRE or AMADEUS. TBML
requires the following steps:

 "Establish” where the parties exchange information about fees etc. Fees are set by the
TBML standards committee: only a supplier that wants to charge fees outside of that
requires manual intervention
 “Quote” – info from requester to supplier, with details of what's needed. Fee payable
by requester. Details of travel returned to requester.
 “Book” – as Quote, but with a booking ref, and larger fees payable.
 "Settle” – where suppliers & requestors get billed & paid by the TBML organisation.

5
(c) eaDocX Ltd 2012

1.2 Organisation
This section contains the current organisation of the new GetLost company. We will attach
Requirements, Issues etc to these individuals, rather than to their project roles, in order to
track individual involvement.

uc GetLost Steering Group Comment [I11]: This is the


first diagram which we have
added.

We can choose to leave-out


diagrams which are not suitable
for our document in several ways:
Martin Jones - CEO Steering Group - diagrams which should never be
printed in any document (because
they are just scratch diagrams) can
be flagged this way in EA
- For all other diagrams, we can
choose to exclude any diagram
individually from a specific
document.

Clare Smart - COO Frank Bey - CTO We have kept the EA frame
Mark Ellsworth -
around this one, but that's an
CMO
option you can change in EA.

Marc Leclerc -
Jilly Smart - Programme
Beth Robinson Product Manager Manager
- Ops

Figure 1 : GetLost Steering Group

6
(c) eaDocX Ltd 2012
1.2.1 Steering group

Alias Individual Description Reqts Comment [I12]: This is a list


of
AC00 Martin Jones - CEO CEO, GetLost Ltd. Quotes,
<<individual>>Actor elements,
Responsible to the parent Providers, which we have chosen to be
company for the success Options printed in a list.
and profitability of GetLost.
Involvement in the day-to- Each element gets a row in the
day running of the project table, and we can choose which
is as head of the Steering attributes appear in which
Group for GetLost columns, and the headings of
those columns.
development.
This change was made Comment [I13]: This row is
today. highlighted, because this
document is using eaDocX
AC01 Clare Smart - COO Chief Operating Officer. Reporting,
Change Marking.
When GetLost is Non-TBML suppliers,
operational Clare will be Role of TBML, This examines the 'last updated'
responsible to the board Ticketless suppliers, date/time of each element,
for all aspects of the KPIs wherever it is printed, and
day- to-day operation of highlights those which have been
the changed since a specified date.
company.
AC02 Frank Bey - CTO Chief Technology Officer This makes it much easier for
readers to go straight to the
AC11 Mark Ellsworth - CMO Chief Marketing Officer Allowed Payment newest part of a document.
Ultimately responsible to methods,
the board for the GetLost Booking, It's not as detailed as Word
product and customer Breaking-up Quotes, change-marking - the reader
experience, in reality will Cancelling bookings, can't see exactly which text was
delegate most decisions to Convert a quote into changed - but all the information
Jilly. a booking, does come from the EA model, so
Customer experience, may have changes made by many
people.
Customer preferences,
Enquiry, Comment [I14]: This is
Non-TBML suppliers, a cross-reference within the
EA model, where one
Pre-stored locations,
element references another
Quote, one. eaDocX has made this
Retrieve previous into a
quotes, hyperlinked cross-reference within
Sign-up, the document.
Storing quotes, Comment [I15]: The data in
Ticketless suppliers, this column comes not from
Quotes, attributes of the Actor, but from
Providers another element which is related
AC12 Jilly Smart - Product Manager Product Manager Providers, to the Actor - in this case, a
Responsible for the Options, related Requirement.
detailed design of the Quotes, This makes those EA relationships
visible in the document, because
product and customer KPIs
they are really important.
experience.
AC05 Beth Robinson - Ops Manager Payments If the target of the relationship
AC06 Marc Leclerc - Programme (the Requirements, in this case)
Manager are also printed in this document,

7
(c) eaDocX Ltd 2012
1.2.2 Other Team Members

Alias Individual Description Reqts


AC03 Jenn Thorson - CLO Chief Legal Officer
AC04 Pierre Carandini - CFO Chief Financial Officer Payments,
KPIs,
Reporting,
Allowed Payment
methods
Maud Sharpe - Business Analyst Responsible for production Comment [I16]: The row
of: shading in this table is another
 Initial requirements option. We have configured all
set tables to use a particular Word
 Use Cases Table Style (called
 Sketches of the eaDocXTableNormal) which allows
user interface us to configure many more
options, including this alternate-
AC07 Nick Adams - Project Manager row shading.
(Launch)
AC10 Barbera Allen-Jones - Test Responsible for the Have look at the options which are
Manager acceptance testing of the available in Word Table Styles -
solution which is provided you can control almost anything
by the supplier of the you want in this way.
GetLost software, and for
running the User
Acceptance Test.
AC09 Edward Alberts - Technical The project technical
Architect architect is responsible to
the Project Manager for
the production of the High
Level Design, and the
production of the
Statement of Requirements
which will be sent to
suppliers of the GetLost
technical solution.

8
(c) eaDocX Ltd 2012
Comment [I17]: In this EA
1.3 Competitor Analysis Package, there are some
<<competitor>>Actor elements.
We used these to capture some
1.3.1 competitor : BlueHorizons. com information about competitors,
and stereotyping 'Actor' seemed a
sensible way to do it.
Author of this analysis Last updated on
As we have quite a lot to say
Fred 23/04/2012 about competitors, we have
chosen to print information about
Overview: them as inline paragraphs, rather
than as rows in the table.
A new entrant into the journey aggregation business, BlueHorizons have quickly become an
innovator in this business. Well financed, but still quite small, they will need to be watched Comment [I18]: This gives
carefully to see what new products they create whilst GetLost is under development. each <<competitor>>Actor its
own heading. We've also chosen
to print the stereotype of the
1.3.2 competitor : GreenHolidays
element in the heading, just to
remind us that we're looking at
Author of this analysis Last updated on competitor information. This is
configurable.
Fred 23/04/2012 Comment [I19]: Although
each element has its own heading,
Overview: we can still use little tables of
attributes. These tables always
Established in 2005, GreenHolidays are the market leader in this field, with 250,000 regular have just one row of data, and a
customers and a dominant position. These are the main competitors to GetLost. heading, as they are showing just
information from a single
custom GreenHolidays element. This is useful where we
want to show lots of attributes of
the elements, each of which has
just a small amount of data.
These can also use a Word Table
Style. We have chosen one which
looks like the one we used above,
with the same shading on the
header row.

Comment [I20]: This is


another reason to print
<<competitor>>Actors as inline
paragraphs - we can configure
them to always print any diagrams
Figure 2 : GreenHolidays which are children of the element.
eaDocX adds the Figure number
(the word' figure' is configurable)
so you can print a Table of Figures,
just like a normal Word document.

9
(c) eaDocX Ltd 2012
1.3.3 competitor : WhyGoAnywhereElse.co.uk

Author of this analysis Last updated on

Ian 22/04/2012

Overview:

This is a UK-based company, who are part of a much larger parent company who are a more
traditional travel vendor. They were created in 2008 as the advanced-technology division of the
parent company, but have yet to make an impact in the world-wide market - they are the leader in
the UK.

Comment [I21]: Another


section. The names of sections can
be changed, to remind us what
should be printed there, but as
they are invisible in the final
document, sometimes we just
keep the default names.

10
(c) eaDocX Ltd 2012
Comment [I22]: Sometimes
having two Word headings, both
2 Initial Requirements of which throw a page break,
causes blank pages - but that's
always been a challenge for
writers of Word documents.

If this EA Package had some notes,


then they would print here.

In our models, we have a standard


that ALL packages ALWAYS have
some notes, even if it just says
'these are the initial
requirements'. It makes the
document more readable, but
more important, it makes the
MODEL more readable, which is
important. Both for you, later on
in the project when you have
forgotten where the information
came from, or for other model
users.

11
(c) eaDocX Ltd 2012

2.1 Board (High Level) Requirements


These requirements are the summary of a board meeting on 11/10/2011, and should be taken as the
initial set of requirements for the project.

Req Ref Name Description Comment [I23]: This is a


HL_REQ_1 Providers "GetLost" will aggregate services from many providers: table of <<high
airlines, hotel booking agencies and hotel Level>>Requirements. Every
chains, coach and train companies stereotype of every element type
can have different formatting.
HL_REQ_2 Options The service shall allow customers to input their source
This makes stereotypes really
and destination location, and the service shall important, but that's just good
provide them with travel options, with prices & times modelling style anyway.
for each. E.g. "Bath" to "London centre" would give
the customer the train, coach, hire-car options We don't HAVE to make each
HL_REQ_5 KPIs Conversion of quotes into bookings is a key performance stereotype format differently - we
indicator for the system, and must be tracked each could just create a default one for
all 'Requirement' elements, which
day/week/month
will get used for any stereotype
HL_REQ_3 Payments Customers shall register their personal details and a which doesn't have formatting of
payment method on the site before a booking can its own.
be
made.
HL_REQ_4 Quotes The Customer shall be able to get a quote, which, if they Comment [I24]: We're quite
are registered, which may be stored in the system, keen on using the EA 'Auto-
for future use, but only if they are registered. Counters' feature to create unique
IDs for most elements, and we put
2.1.1 Risks those into each element's 'Alias'
attribute.
This is just how we have chosen to
Risk Ref construct our model.
Risk Risk Description
KPIs TBD
GL-03 Payment reconciliation There is a risk that the reconciliation mechanism will
require additional work (not included in
scoping/estimates). This will result in additional
costs and schedule delivery impact.
GL-04 Providers commercial deals There is a risk that deals cannot be negotiated with
providers

12
(c) eaDocX Ltd 2012

2.2 Detailed Requirements


2.2.1 Definitions

Req Ref Name Description


REQ005 Enquiry An enquiry uses data that the TravelOptimizer has gathered
from suppliers, but which is non-binding. Suppliers provide this Comment [I25]: These are
data free all tables of 'Requirement'
REQ004 Quote A Quote involves the system communicating with the supplier elements. eaDocX makes the
to obtain a real-time value of the price of the ravel, hotel, flight columns all the same width, and
etc uses all the same formatting for
each table.
REQ003 Booking A Booking is where a quote is made into a firm purchase of
services
Choosing the width of columns is a
matter of trial-and-error:
2.2.2 Signing-up new suppliers experiment with what looks good
for your data.
Req Ref Name Description
REQ000 Sign-up There will need to be a process for signing-up new suppliers.
Suppliers systems should all conform with the TBML (Travel
Booking & quotes Markup Language) standard, otherwise we
will have to produce bespoke interface code for each supplier.
REQ001 Role of TBML All TBML-compliant suppliers get paid via the TBMLCo.
Payment Settlement System (PSS), where consumer
companies (like GetLost ) pay Suppliers once a month, via
a single payment to TBMLCo. which in turn distributes
those
funds to suppliers.
REQ002 Non-TBML Senior Manager approval shall be required in order to sign-up
suppliers a non-TBML supplier, who must have obtained a firm quote
for the creation of the interface software from our out-
sourced software providers (IBM), plus approval from our IT &
testing
managers

2.2.3 Enquiries, Quotes and Bookings

Req Ref Name Description


REQ014 Cancelling bookings Under some circumstances, a booking may be cancelled,
though different suppliers have different rules and fees for
this.
REQ015 Ticketless suppliers Wherever possible, GetLost? will use ticketless suppliers, but
this may not always be possible.

2.2.3.1 Quotes
Req Ref Name Description
REQ016 Breaking-up Quotes Requests for quotes get broken-up into separate request for
journey 'Steps', which may be sent to many different suppliers.

13
(c) eaDocX Ltd 2012
REQ006 Customer experience A Customer shall be able to tell the system their travel
requirements e.g. time & date, start & end points, restrictions
& preferences, then the system will give recommended travel
Req Ref Name Description
options.
REQ007 Pre-stored locations There shall be a be a set of start & end locations pre-stored
e.g. "London - Trafalgar Square" , plus the customer shall
be able to store their own locations.
REQ008 Storing quotes Customer may then store those journeys as a quote
REQ009 Retrieve previous Customer shall be able to login and retrieve previous quotes
quotes
REQ010 Convert a quote Customer shall be able to convert a quote into a booking
into a booking
REQ011 Allowed Payment The solution shall accept only credit or debit card payment
methods methods
REQ012 Reporting We need reports on: revenue by supplier, - conversion rates
per day/week/month, segmented by customer type, -
commission rates per hour/day/week/month, by customer
segment and supplier. Other reports to be determined
REQ013 Customer Customer shall be able to save their preferences e.g. for a
preferences particular airline or hotel chain or model of transport.

14
(c) eaDocX Ltd 2012

15
(c) eaDocX Ltd 2012

3 Use Case Model


These are the required use cases for GetLost.
uc Use Cases

GetLost
(ISS056)
No business
owner for
these use
(UC03) (UC08) cases
Search for Trav el Establish new Supplier

Browser

«include»

(UC05)
Register
(UC01) Supplier
Check new
supplier

(UC04)
Customer Get Quote (UC09)
Pay TBMLCo.

TBMLCo.

(UC06)
(UC02)
Make Booking Establish non-TBML
supplier
Manager

«include»

(UC07)
Collect money from
client

Payment
Service
System

Domain (ISS034)
expert Cash
needed collections
process

Figure 3 : Use Cases

16
(c) eaDocX Ltd 2012
3.1 Actors
Actor Description Uses Use Cases
TBMLCo. Pay TBMLCo.
Manager Establish non-TBML supplier Comment [I26]: These
Browser An anonymous person, just Search for Travel attributes come from relationships
browsing around the net. which we have created in EA
We think it is important to between Actors and Use Cases.
support these users, as if they Because the Use Cases are also
printed in this document, the
have a good experience as
attributes are created as
browser, they may decide to go
hyperlinks.
further and register. However,
we don't want to be TOO nice to This allows readers to 'browse'
them. your document, just as they would
Customer A Browser becomes a Customer Make Booking, a website, by following links
at the point where they Register. Register, around the document, rather than
Get Quote reading it from start to finish.
Payment This is the only means by which Collect money from client Comment [I27]: Another
Service System a customer can make a payment internal cross-reference, from
to GetLost, via the single within EA.
Payment Service System. Who
that supplier will be will be
determined later in the project,
once detailed requirements are
known.
Supplier

17
(c) eaDocX Ltd 2012

3.2 Use Cases


3.2.1 Customer use cases

3.2.1.1 UseCase : Get Quote


Description:

Allows a user to get a quote for a journey, either a new one, or one previously stored. The quote
has indicative, not contractual, prices for all Steps of the Journey.

3.2.1.1.1 Scenarios
Comment [I28]: This is
3.2.1.1.1.1 Basic Path : Get Quote how eaDocX can print EA
Structured Scenarios.
Each scenario is a separate table
# Step Extensions of steps (we could have printed
them as separate paragraphs, but
Use Case starts when the user decides they want a quote.
1 we thought a table looked neater)
This might be a Browser or Customer.
Retrieves previously
2 User enters the details for the quote (details TBD)
stored quote
System breaks the quote into individual Journey Steps and Invalid Quote
3 asks Supplier systems to create quotes for each Step request Comment [I29]: Where the
System creates a consolidated Quote from the individual scenario has alternates and
4 exceptions, eaDocX automatically
Steps, and shows that to the user.
creates hyperlinks to those.
3.2.1.1.1.2 Alternate : Retrieves previously stored quote
This means your EA model can use
the full power of EA Structured
# Step Scenarios, and the document can
show all the links which you
User may ask system for a list of previously created.
1
stored quotes
2 System shows user the lists of quotes
3 User chooses one.
Rejoi Comment [I30]: If your
ns at: Get Quote step:3
Structured Scenario specifies
where the Alternate path rejoins
3.2.1.1.1.3 Exception : Invalid Quote request
the main path, that also becomes
a hyperlink.
# Step
System indicates to the user what information
1 is required
Design Note: good UI design should prevent a
2 badly-formed quote from being submitted in
the first place.
Comment [I31]: Note that
exceptions - according to the UML
definition - don't rejoin the basic
path. That would make them
alternates.
So, Exception paths don't print a
'rejoins' attribute

18
(c) eaDocX Ltd 2012
3.2.1.2 UseCase : Register

3.2.1.3 UseCase : Make Booking

3.2.2 Administration use cases

3.2.2.1 UseCase : Check new supplier Comment [I32]: These are a


bunch of Use Cases which we
3.2.2.2 UseCase : Collect money from client haven't written yet

3.2.2.3 UseCase : Establish new Supplier

3.2.2.4 UseCase : Establish non-TBML supplier

3.2.2.5 UseCase : Pay TBMLCo.

3.2.2.6 UseCase : Search for Travel

19
(c) eaDocX Ltd 2012
Comment [I33]: We like to
3.3 Issues keep Issues within our EA models,
and link them to the EA elements
Issue Ref Issue Description
(Requirements, Use Cases,
ISS034 Cash collections process We seem to be missing a whole set of processes Components) to which they refer.
for the collection of un-paid invoices to Suppliers This means we don't have to keep
Domain expert needed Who is the domain expert for this system? spreadsheets of issues external to
Nobody yet identified EA.
ISS056 No business owner for these use These use cases have no Business Owner, hence
cases no Actor

20

You might also like