Book a Demo

Author Topic: Format of internal documentation when exporting  (Read 5972 times)

[email protected]

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Format of internal documentation when exporting
« on: July 07, 2006, 02:14:14 am »
Hello,

I want to write a report generator for EA (no, I don't want to use the built in one - I have my causes) and I wondered about the format of the linked documentation after export.

What I know is, that it is a base64 coded ZIP File that contains the documentation.
But what format does the documentation have? It is not RTF... It seems to be proprietary.

Dear Sparx, could you provide a tool / automation function to convert the documentation to RTF, please?

thomaskilian

  • Guest
Re: Format of internal documentation when exportin
« Reply #1 on: July 12, 2006, 05:38:55 am »
Just curious: what internal documentation are you talking off?

JohnWSaundersIII

  • EA User
  • **
  • Posts: 50
  • Karma: +0/-0
    • View Profile
Re: Format of internal documentation when exportin
« Reply #2 on: July 12, 2006, 10:36:34 am »
I don't know if this is what the O.P. had in mind, but I also wrote a "replacement" for the RTF generator (in XSL 2.0). One thing it lacked was the ability to display linked documentation. This is present in the XML as a bunch of hexadecimal, and I didn't know what it was meant to represent.

John
John Saunders

[email protected]

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Re: Format of internal documentation when exportin
« Reply #3 on: July 15, 2006, 10:17:47 am »
Hello,

I mean the 'linked documentation' (new feature of V6 (?) I think).
The 'bunch of hex' is in reality a base64 coded zip file (you can try opening it by exporting XMI, copying the hex bytes to one of the free online base64 decoders, saving the result to foo.zip). Inside the zip file there is the linked documentation (I think the filename was 'str.dat' or something like that). But I don't know the file format of this file. I think its proprietary.

it would be wonderful to get a standalone program from sparx that converts this thing into RTF, or a function in the EA automation interface to save a 'linked document' into rtf directly...

Dr.T

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Format of internal documentation when exportin
« Reply #4 on: August 31, 2007, 07:42:34 am »
This is my problem as well

Could Sparx please :) let us both know what the format of the str.dat is?

(I would also like to be able to get hold the embedded RTF files to convert them to XML and XSL-FO for further processing)

T.

Dr.T

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Format of internal documentation when exportin
« Reply #5 on: August 31, 2007, 07:43:02 am »
This is my problem as well

Could Sparx please :) let us both know what the format of the str.dat is?

(I would also like to be able to get hold the embedded RTF files to convert them to XML and XSL-FO for further processing)

T.

Dr.T

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Format of internal documentation when exportin
« Reply #6 on: August 31, 2007, 07:45:14 am »
I need to get hold of the contents of the embedded rtf files in the XMI as well.

Could Sparx please :) let us both know what the format of the str.dat is?

(I would also like to be able to get hold the embedded RTF files to convert them to XML and XSL-FO for further processing)

T.

Dr.T

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Format of internal documentation when exportin
« Reply #7 on: August 31, 2007, 07:45:50 am »
I need to get hold of the contents of the embedded rtf files in the XMI as well.

Could Sparx please :) let us both know what the format of the str.dat is?

(I would also like to be able to get hold the embedded RTF files to convert them to XML and XSL-FO for further processing)

T.

Aaron B

  • EA Administrator
  • EA User
  • *****
  • Posts: 941
  • Karma: +18/-0
    • View Profile
Re: Format of internal documentation when exportin
« Reply #8 on: September 02, 2007, 02:24:35 pm »
To extract a Linked Document from your model, try using the Element.GetLinkedDocument() method in the Automation Interface.
http://www.sparxsystems.com.au/EAUserGuide/element2.htm

Dr.T

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Format of internal documentation when exportin
« Reply #9 on: September 03, 2007, 12:04:00 am »
This is great, *but* it means that you have to process both the XMI and go direct via the automation interface to get the RTF docs and then tie them back together again, which would be a lot of extra effort and a much more complex solution.

It is certainly a workaround if it is *impossible* to translate rtf docs from the XMI, but why would you put them in the XMI if it were completely impossible to get them out again?

Is there a way of translating the strings containing the RTF docs in the XMI?

Thanks for your help