Author Topic: Publish from model to .doc from external script?  (Read 322 times)

F@lk

  • EA Novice
  • *
  • Posts: 10
  • Karma: +0/-0
    • View Profile
Publish from model to .doc from external script?
« on: May 28, 2019, 12:41:38 am »
Hi,
Is there something like this?
c:\temp\cool_tool.exe /from=my.eapx /to=documentation.doc

My build system should generate the docs from EA model DB file per script.

Thanx in advance

Arquesoft

  • EA User
  • **
  • Posts: 252
  • Karma: +5/-3
  • EA Consulting and development in Spanish
    • View Profile
    • Arquesoft website
Re: Publish from model to .doc from external script?
« Reply #1 on: May 28, 2019, 12:57:31 am »
It is something wrong in the question: you are not considering that an EAP file could include several root nodes (not just only one), and documentation is supposed to be for a selected package/element. So, if you pretend to generate a .doc from a model, you should also pass "as parameter" the package you need to document.

I think there is no tool for that, but theoretically, it could be written as an external app.

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 9392
  • Karma: +258/-27
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Publish from model to .doc from external script?
« Reply #2 on: May 28, 2019, 05:46:57 am »
No, I've never heard of a tool that does that either.
But you can indeed write one yourself. It could even be as simple as a VBScript or something like that.

Geert

timoc

  • EA User
  • **
  • Posts: 104
  • Karma: +6/-0
    • View Profile
Re: Publish from model to .doc from external script?
« Reply #3 on: May 28, 2019, 06:44:21 pm »
I was wondering about something like this myself.
Can you use EALite to generate (HTML) documentation as part of an automated build process?

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 9392
  • Karma: +258/-27
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Publish from model to .doc from external script?
« Reply #4 on: May 28, 2019, 07:10:26 pm »
I was wondering about something like this myself.
Can you use EALite to generate (HTML) documentation as part of an automated build process?
They limited the usage of the API from EA Lite quite a bit a few years ago.
Not sure if this also means you can't generate the a HTML report, but I wouldn't be surprised if it was.

Why would you need EA Lite for that?

Geert

timoc

  • EA User
  • **
  • Posts: 104
  • Karma: +6/-0
    • View Profile
Re: Publish from model to .doc from external script?
« Reply #5 on: May 28, 2019, 09:38:06 pm »
I was wondering about something like this myself.
Can you use EALite to generate (HTML) documentation as part of an automated build process?
They limited the usage of the API from EA Lite quite a bit a few years ago.
Not sure if this also means you can't generate the a HTML report, but I wouldn't be surprised if it was.

Why would you need EA Lite for that?

Geert
Makes it easier to put into a headless triggered build chain, like Jenkins, without having to make a license available. For automatically publishing models etc.




timoc

  • EA User
  • **
  • Posts: 104
  • Karma: +6/-0
    • View Profile
Re: Publish from model to .doc from external script?
« Reply #6 on: May 28, 2019, 09:50:16 pm »
No, I've never heard of a tool that does that either.
But you can indeed write one yourself. It could even be as simple as a VBScript or something like that.

Geert
You might find something helpfull here:
https://github.com/docToolchain/docToolchain/tree/master/scripts

Ralf

  • EA User
  • **
  • Posts: 25
  • Karma: +0/-0
    • View Profile
Re: Publish from model to .doc from external script?
« Reply #7 on: June 02, 2019, 07:44:49 pm »
thanx @timoc for mentioning docToolchain here.
I am one of the core committers to docToolchain.

Yes, docToolchain contains a script which starts EA headless and exports all diagrams and element notes.
I use it to generate several types fo documentation output, but to get .docx output, we use AsciiDoc as Markup inbetween.
So, we write docs in AsciiDoc and reference the diagrams exported from EA in these docs. The AsciiDoc files can then be converted to HTML, PDF and DOCX.

Here is the documentation for the exportEA step: https://doctoolchain.github.io/docToolchain/#_exportea