Remote Model Documentation

USE: Remote Model Documentation

(Details - Use - Extend)

The remote model documentation building block can be integrated in your modelling tool implementation by extending/configuring its functionality as a new menu item to trigger the AdoScript client to interact with the server documentation generation engine.

Examples for the output created (HTML, PDF) can be found on the bottom of this page.

 

In the following, the steps to integrate the client and configuration capabilities are explained.

  • 1. Download Resources for Integration

    3 files need to be available in your library (to get all in a package, use the ZIP download below):
     

    • RemoteDocumentation.asc: This AdoScript enables the communication between your tool and the web-service. It acts as a client to retrieve a list of available reports, uploads the necessary files for the report to the server, triggers the report generation and downloads the results.

    • wget.exe: To enhance the platform functionality, the wget.exe is needed to run downloads/crawls of the results. You can download wget.exe directly from the developer (http://gnuwin32.sourceforge.net/packages/wget.htm) or as part of the package below.

    • curl.exe: To enhance the platform functionality, the curl.exe is needed to run uploads of input files to the server. You can download curl.exe directly from the developer (http://curl.haxx.se/) or as part of the package below.

    PACKAGED DOWNLOAD (all in one)

  • 2. Extract Archive and Import into Your Library

    Extract the package above on your local harddrive and import the 3 files contained into your library (see Video tutorial).

  • 3. Add Menu Entry to Trigger Remote Documentation Client

    Add the following lines to your library configuration (Dynamic Library -> Library attributes -> External coupling) to add a new menu entry. Alternatively, you can also trigger the service from a button or programmcall (details on triggering an AdoScript can be found here).


    #################################################################
    ######## REMOTE DOCUMENTATION TRIGGER ########
    #################################################################
    ITEM "Create remote documentation" importexport:"Documentation"
    SETG sRemoteDocumentationURL:"https://www.adoxx.org/remotedocu/modeldocu/"
    EXECUTE file:("db:\\RemoteDocumentation.asc")



     

    ATTENTION: Make sure to adapt the URL (https://www.adoxx.org/remotedocu/modeldocu) if you have deployed the service at a different location (e.g. your own infrastructure).

  • 4. Result of Integration

    After completing the 3 steps you will have a new menu item available in the import/export component called "Create remote documentation." This menu item triggers the interaction between your tool and the remote documentatation engine.

RESULT Example: HTML Documentation

RESULT Example: PDF Documentation