Generate documentation - structured scenario

[gihad.baroudi]

Hi all, first of all, sorry for my englishn i'm french.

I'm trying to générate my documentation using a template.
I want to generate my use case witch contains a structured scenario.

In some steps of my structured scénario, i'm using some context reference or glosarry definition.

All thoses reference are requirements (for me).

Then i can't succed to make thoses requirement appear when i generate documentation of my use case.


for exemple :

I have a use case named USECASE1.
a requirement REQUIEREMENT1 (note is : this is the note of my requirement1)

In my use case i have a structured scénario :

step1 : user do this
step2 : system reply that
step3: user do this, REQUIREMENT1
...etc


Requirement1 is a context reference. I can also put it in the 'uses' colomn.

My purpose is, when i generate my specification to have that :


step1 : user do this
step2 : system reply that
step3: user do this, this is the note of my requirement1
...etc


SO i want to insert in steps of my structured scénarios, some dynamic text .... that can be holded by object (here requirement). My proble is that i cannot find in the sections of my template (when i edit my template) something like that.


I'll be grant if someone know an issu  


Thanks for your help

[Ian Mitchell]

Have a look at eaDocX - there is good support for printing structured scenarios

[gihad.baroudi]

Ok Thank you for your reply.

I'll try the trial version and if it can do what i want will buy it.
We have in my administration, about 10 EA license, will see if we need to buy 10 eadocx license
 

[Eve]

I don't know what eaDocX does with structured scenarios, but EA itself provides both a simple method of showing the steps in a template, as well as a full template section that may provide what you need.

[gihad.baroudi]

Thanks for your answer SIMON,

I'have tried EADOCX , and as it is precised in the name, you can only make it work with MSOFFICE and not OPENOFFICE (that's what i've understood).

So, can you telle me how to get access to that full template section.

When i edit a template (or create one) i can't see wich section i have to use to get my context reference element detais, when i describe my scenario's spets.

Thank for your help.

[Eve]

In the section tree check the Package | Element | Scenario | Structured scenarios and Exception sections. The structured scenarios one provides a uses field.

[gihad.baroudi]

Thanks SImon for your reply,

that's what i did, but in my documentation, i can only have the name of my requirement 'REQUIREMENT1' holded by the 'use' field, and not the description of my requirement witch is in my requirement note.

I'm going on looking for a solution , thanks for your ideas !  

[raphael.abreu]

Yes, you can do almost everything using custom scripts (VBScript or JScript).

Is frustrating to have a tool like EA and a document generator so limited and boring.

I refuse to pay a additional license for a plugin-software based to solve trivial problems of this kind. I believe that the EA software should rather evolve to provide better controls for customizing our templates.

See a problem I'm facing here: http://www.sparxsystems.com/cgi-bin/yabb/YaBB.cgi?num=1425691932

[gihad.baroudi]

THanks Raphael for your answer,

i agree with you, EA is so powerfull, and its estonish that the document generator is soo poor.

i' will try to use scripts, but i have to learn how  

i have seen on your post that you have found a solution for your pb !!

happy for you  

[Geert Bellekens]

I refuse to pay a additional license for a plugin-software based to solve trivial problems of this kind. I believe that the EA software should rather evolve to provide better controls for customizing our templates.

Raphael,

You do realize that you are now spending a lot more money (or your bosses money) developing a document generator yourself then you would if you bought the eaDocX license.

And to clarify, eaDocX is sold by an independent company, not by Sparx Systems. I guess they had the same feeling as you did about the poor document generator, but they did something about it. They created a better one and they are selling that now so you (and me) don't have to.

Geert

[gihad.baroudi]

Hi all,

Geert, may be you right, that kind of tools is done to avoid spending time making them individually.

But according to Raphael, EA have to propose us, natively, such tools.

I'm not against buying some usefull tool, like EADOCX, but i can't understand why they limited their tool to MSOFFICE ....so i have to  buy a MS OFFICE tu use EADOCX.

Even to try the trial version. It would be bettre if i could try this with open office for exemple ...

[Geert Bellekens]

Hi all,

Geert, may be you right, that kind of tools is done to avoid spending time making them individually.

But according to Raphael, EA have to propose us, natively, such tools.

I'm not against buying some usefull tool, like EADOCX, but i can't understand why they limited their tool to MSOFFICE ....so i have to  buy a MS OFFICE tu use EADOCX.

Even to try the trial version. It would be bettre if i could try this with open office for exemple ...

I agree on both accounts. Have you asked Ian Mitchell (the owner of eaDocX) about his opinion on supporting Open Office?

Geert

[Eve]

I'm not against buying some usefull tool, like EADOCX, but i can't understand why they limited their tool to MSOFFICE ....so i have to  buy a MS OFFICE tu use EADOCX.

I've never seen eaDocX code, but I suspect that it's using APIs provided by MS Word to generate the report. It would likely be extremely difficult to make it work without those APIs.

It's true that you can't do everything using the built-in generator, but in my experience the problem people usually have is that it gets too complex to understand long before they reach the limits of the generator. If you want to maximize the flexibility try the DocumentGenerator class in our API.

[Geert Bellekens]

I'm not against buying some usefull tool, like EADOCX, but i can't understand why they limited their tool to MSOFFICE ....so i have to  buy a MS OFFICE tu use EADOCX.

I've never seen eaDocX code, but I suspect that it's using APIs provided by MS Word to generate the report. It would likely be extremely difficult to make it work without those APIs.

The document generator we wrote uses OpenXML. We can output to .docx without using the MS Word API buy manipulating the xml format of the .docx directly.

The main advantage of this approach is that it is much much faster then using the Word API.

I don't know which technology Ian uses in EADocx.

Geert

[gihad.baroudi]

Hi all,

first of all thanks for all your replies and advices.

I succeded by using a VB script that using the DocumentGenerator Class :

http://www.sparxsystems.com/enterprise_architect_user_guide/9.2/automation/document_generator_interface_class.html

that works well.

 


but i have another question .... in that topic. :

http://www.sparxsystems.com/cgi-bin/yabb/YaBB.cgi?num=1427893087/0#0