Automic Workload Automation

Expand all | Collapse all

How to integrate the local documentation into ECC/AWI with Tomcat

  • 1.  How to integrate the local documentation into ECC/AWI with Tomcat

    Posted 01-30-2017 10:38 AM

    When one wants to integrate the local Documentation (local Web help) to the ECC or AWI the following steps need to be done:

    1)      Create a new folder in the Tomcat installation in the webapps folder and name it for example "DOCU_11.2"

    2)      Copy the content of the webhelpe.zip (which can be found in the Documentation folder of the Automation Engine in Guides\webhelp\english) to this folder

    3)      Copy and Paste the help.htm to the exact same location without overwriting it (so that two help.htm files are available)

    4)      Rename the help – Copy.htm to index.htm

    5)     open the website in your browser (best advice is to open it via the Tomcat Manager) – the website can have now the following address: http://localhost:8080/DOCU_11.2/

    6)      This address now needs to be copied to the configuration.properties file of your ECC/AWI installation (which is located in the config folder of your ECC/AWI installation) the following way:

    helpUrl.english = http://localhost:8080/DOCU_11.2/

    7)      Now when you open via the ECC/AWI the Help this path for the documentation is taken instead of the standard path:

    helpUrl.english = https://docs.automic.com/documentation/ECC/11.1/Guides/webhelp/english/help.htm



  • 2.  How to integrate the local documentation into ECC/AWI with Tomcat

    Posted 12-18-2017 11:31 PM
    Thank you for the detailed instruction,
    Just want to add some screenshots for illustrative purpose:
    1. Create folder in Tomcat webapps folder namely "DOCU_AWI" (or anything you like)
    lkf2rfej7uq6.pnghttps://us.v-cdn.net/5019921/uploads/editor/q3/lkf2rfej7uq6.png" width="452">
    2. Download and unzip webhelpxx.zip (with xx regarding your favorable language) straight into the newly created folder (i.e below image)
    18okt2bu7rdd.pnghttps://us.v-cdn.net/5019921/uploads/editor/zw/18okt2bu7rdd.png" width="532">
    3. Copy and rename your help.htm into an additional file index.htm and put it in the same folder (you will need it for the index of the accessible local page)
    k2kdfnppa9v8.pnghttps://us.v-cdn.net/5019921/uploads/editor/8a/k2kdfnppa9v8.png" width="250">
    4. You now can test access to the local help page (i.e at yourhostIP:8080/DOCU_AWI/)
    1ixvo4zdjizj.pnghttps://us.v-cdn.net/5019921/uploads/editor/80/1ixvo4zdjizj.png" width="1303">
    (Since you are supposed to use the same Tomcat for hosting ECC/AWI then should it be similar to your ECC/AWI address)
    qpwtp1fayhkp.pnghttps://us.v-cdn.net/5019921/uploads/editor/32/qpwtp1fayhkp.png" width="1299">
    5. Modify the Tomcat/webapps/awi/config/configuration.properties to add the instructional property to use the local webhelp instead of online documents.
    3z2r23hdc9zz.pnghttps://us.v-cdn.net/5019921/uploads/editor/17/3z2r23hdc9zz.png" width="682">
    (please be informed that the configuration.properties should be a blank document when you first opened it since it supposes to contain instructional properties that you have not instructed it yet, so don't be worry, just add what you need)
    6. Now re-log onto your ECC/AWI and you can access the local context-sensitive webhelp from the menu panel at the top right corner
    oyb6w71m6psf.pnghttps://us.v-cdn.net/5019921/uploads/editor/1w/oyb6w71m6psf.png" width="1102">

    Just another note that you can use any hosting method such as Tomcat or IIS at will, the above is just one way to host the webhelp and make it available to your local intranet. Using tomcat would make it easier as you don't have to install or activate any other additional tools and the accessible address would be just similar to your AWI address.
    Another note that the contents of this webhelp is also context-sensitive according to your current AWI section, and you have to manually update the contents via the above method whenever it seems to be outdated.

    Regards,
    Tuan Hoang