ABLdoc for database tables - Forum - OpenEdge Development - Progress Community
 Forum

ABLdoc for database tables

This question is answered

Hi everyone, 

I'm wondering if it is possible to generate documentation of the databases using ABLdoc or a similar tool?

The information that we would like to retrieve:

  • Table name
  • Field names
  • Primary keys
  • Foreign keys
  • Format
  • Label
  • Initial value
  • Order
  • Description
  • Help text
  • (Triggers)
  • (Validation)
  • (etc...)

Can someone tell me if this is possible. 

Best regards,

Johan Vergeer

Verified Answer
  • You can take a look at HtmlDict for this. It is on the OE Hive, but if I have time I'll see if I can port it to GitHub. It generates static html pages for your database schema. 

    Personally, I use the DataDigger for database references, but depending on what you want to do with it, HtmlDict might be a better choice. Please forgive me the somewhat old fashioned look of the pages, but remember that it is already ten years old :)

    Download the zip, extract it in its own folder, add that folder to the propath and run HtmlDict.w

All Replies
  • PCT has a schema documentation task

    github.com/.../PCTSchemaDoc

  • In the example they mentioned SchemaDoc.xsl.

    Where can we get this file for formatting ?

    <PCTSchemaDoc file="doc/db.xml">

     <PCTConnection dbName="MyDB" dbDir="base"/>

    </PCTSchemaDoc>

    <xslt in="doc/db.xml" style='doc/SchemaDoc.xsl' out='doc/output.txt'>

     <param name="outputdir" expression="doc/MyDB"/>

     <param name="dbname" expression="MyDB" />

    </xslt>

  • You can take a look at HtmlDict for this. It is on the OE Hive, but if I have time I'll see if I can port it to GitHub. It generates static html pages for your database schema. 

    Personally, I use the DataDigger for database references, but depending on what you want to do with it, HtmlDict might be a better choice. Please forgive me the somewhat old fashioned look of the pages, but remember that it is already ten years old :)

    Download the zip, extract it in its own folder, add that folder to the propath and run HtmlDict.w

  • Thanks for sharing this solution. It is exactly what I was looking for.

    Don't worry about the look, I have seen much worse. ;)

  • There's a link to schemaDoc.xsl in the first paragraph.

  • Gr8!

    Also where can we find the XSL file for ABLUnitTesting result.xml ?

  • This is meant to be displayed directly in Jenkins, so no XSL here

  • How can we see then the ABLUnitTesing results.xml without Jenkins in a  good HTML format ?

  • The format of the file that is produced is a standard format from JUnit tests - there *are* XSLT files out there to convert the XML into HTML formats, although they are a little hard to find.

    I do have one in my possession, however, I found it several years ago and can't remember where I found it, so don't wish to post it in case of license infringement.

    As I said, they do exist, you've just got to put some time into finding them.

  • a quick Google returned:

    stackoverflow.com/.../converting-xml-junit-report-to-html

    perhaps this might help - it references github.com/.../junit2html too

    Steve

  • Maybe not exactly what is commonly understood as documentation, still maybe some visuals would help as well...

    Marian Edu
    Acorn IT 
    +40 740 036 212
  • Thank you for your answer Marian,

    I have looked in Progress Developer Studio for an ERD diagram, but haven't been able to find it.

    How did you create this ERD?

  • The reason you couldn’t find one is because it doesn’t exist, very few seems to even want such a thing and given the fact PSC is a listed company they might not put in resources for something no one needs :(

    The ERD component is one part of our work in progress (sic) on an integrated development environment, crowdfunding doesn’t seem to be appealing for Progress community either so we just go ahead slowly but steady… some more info on it here: https://www.indiegogo.com/projects/openedge-integrated-development-environment#/ 



    Marian Edu

    Acorn IT 
    +40 740 036 212

  • IAP is offering PCase to design and document your ERD diagram. You can download a free Test Version here:
     
    http://www.iap.de/pcase/

    Best,
    Hendrik

    Am 10.05.2017 um 14:00 schrieb Johan Vergeer:
    Update from Progress Community
    Johan Vergeer

    Thank you for your answer Marian,

    I have looked in Progress Developer Studio for an ERD diagram, but haven't been able to find it.

    How did you create this ERD?

    View online

     

    You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here.

    Flag this post as spam/abuse.


    -- 
    
    Hendrik Duerr
    
    IAP GmbH, Valentinskamp 30, D-20355 Hamburg
    Tel.+49 40-30 68 03-34  
    hendrik.duerr@iap.de - www.iap.de
    
    Geschäftsführer: Klaus de Vries, Klaus Erichsen, Ulf Abel
    Amtsgericht Hamburg, HRB 61291
  • well, Marian, I would suggest that you ditch development - as you seem to be able to raise money out of thin air ...$1600 from 0 backers ...  :)