It's all about the answers!

Ask a question

How to deploy help content to an intranet server?


John Smith (3858) | asked Oct 08 '12, 2:01 a.m.
retagged Oct 09 '12, 8:13 a.m. by Hadar Hawk (1881914)

Hello All,

I am trying to set up an intranet server (Windows) as a Rational products help server.  Our help server host and Jazz server host are different.  I checked the following and deployed help.war on Tomcat.

http://pic.dhe.ibm.com/infocenter/clmhelp/v3r0m1/index.jsp?topic=%2Fcom.ibm.help.common.rational.remote.web.doc%2Ftopics%2Ft_setup_intranet_web.html

The help server doesn't have internet access so I downloaded CLM3.0.1.3_updateSite.zip and DoorsDWA9.4.0_updateSite.zip from http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/.

My questions are about the following information.

http://pic.dhe.ibm.com/infocenter/clmhelp/v3r0m1/index.jsp?topic=%2Fcom.ibm.help.common.rational.remote.web.doc%2Ftopics%2Ft_download_help_web.html

Q1. The procedure 1.b. mentions "Move the updateSite.zip file to the location where the help WAR file is running".  Does this updateSite.zip mean CLM3.0.1.3_updateSite.zip.  If not, where can I get updateSite.zip ?  In the above updatesites, there is updateSite_zip.zip but it cannot be unzipped.

Q2. I need help for CLM and DOORS and would like them to have separate URLs. (i.e. When accessing to CLM help URL, the page shows only CLM help and doesn't show DOORS help)                                        The procedure 2. mentions "On the help server, navigate to https://localhost:port/help-name/updater/updatewar.jsp. Tip: To find the help context root (server, port, and help-name), open the help from the product by clicking ? > Help contents. Your URL is https://server:port/help-name/index.jsp.Instead of server, use localhost or 127.0.0.1. "

When I access to https://myJazzServer:9443/ccm/admin and click ? > Help contents, the URL is https://myJazzServer:9443/clmhelp/index.jsp.  Does this mean that http://myHelpServer:8080/clmhelp/index.jsp is my CLM help URL? 

I am asking this becasue the following IC mentions "After you open the startup page, you can access the help system by adding help/index.jsp to the end of your URL: http://localhost:8080/help/index.jsp ." in step 6.

http://pic.dhe.ibm.com/infocenter/install/v1r4/index.jsp?topic=%2Fcom.ibm.im.articles.doc%2Ftopics%2Ft_setup_intrnet_help_content.htm

Any information would be very much apprecaited.

John. 


Comments
Der M commented Oct 08 '12, 6:58 a.m.

Oh yeah, don't forget to use the localhost in the updater.jsp URL, not the hostname.  This was a blocker for me.  On using fire fox and the locahost url, I was able to access the correct url to apply the fixes.  See the link in my previous post.

5 answers



permanent link
Hadar Hawk (1881914) | answered Oct 09 '12, 8:12 a.m.
FORUM MODERATOR / JAZZ DEVELOPER
Hi John,
Sounds like you are able to set up the help as an intranet IC.  Congrats.   I just wanted to mention you can also add the DOORS help if you like by following the same steps as you did to install the CLM help. 


permanent link
John Smith (3858) | answered Oct 10 '12, 2:44 a.m.

Hi Hadar,

I set up CLM help by the following steps.  Could you please confirm if it is correct?  The steps are different from what IC (http://pic.dhe.ibm.com/infocenter/clmhelp/v3r0m1/topic/com.ibm.help.common.rational.remote.web.doc/topics/t_setup_intranet_web.html) mentions and I did this way because adding local content didn't work with help.war. (I specified the site.xml file but the content was not listed as available contents)

1. Copy clmhelp.war from <RTC server>\server\tomcat\webapps to <Tomcat for help server>\webapps

2. Upzip CLM3.0.1.3_updateSite.zip to c:\temp

3. Go to http://localhost:8080/clmhelp/updater/updatewar.jsp and add c:\temp\CLM3.0.1.3_updateSite\site.xml as the available contents

4. Select the added content and click "Install"

Now I can access to the CLM help from http://MyHelpServer:8080/clmhelp/index.jsp

I would like to separate helps for each Rational product (i.e. http://MyHelpServer:8080/clmhelp/index.jsp shows only CLM help and doesn't contain DOORS help) so my understanding is that I have to have help application for DOORS and install the DOORS help contents. Right?

There is dwa-help.war under c:\IBM\Rational\DOORS Web Access\1.4.0.5\server\webapps but this seems to already have DOORS and DWA help contents which is different from clmhelp.war.  In this case, should I simply deploy dwa-help.war to our help serer? (I'm using DOORS 9.3)

John,


permanent link
Der M (6121318) | answered Oct 08 '12, 6:55 a.m.

Hi there John.

I had the very same problems.  If you hav ea look through my post here  how to install help you should see the answers.  The help is a little fuzzy on this.  I would use Fire Fox as my browser when trying this and you may need to refresh a couple of times for it to work.  Once you have downloaded and dropped the files into the correct directory, you need to copy and paste the update directory into the updater.jsp directory dialog box.  It should work.  Following the instructions given to me in the above post.


Comments
1
John Smith commented Oct 09 '12, 2:41 a.m.

Hi Der,

Thank you very much for the information. 

I downloaded help.war from the following site according to IC but the help.war seems to have some problem.

http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/war/help.war

So I copied clmhelp.war from my RTC server install directory and pasted it to <Tomcat>\webapps directory on my help server and access to http://localhost:8080/clmhelp/updater/updatewar.jsp.  In this case I could add unzipped CLM3.0.1.3_updateSite.zip as the internal site and install it.

Now I can access to CLM help from http://myHelpServer:8080/clmhelp/index.jsp.

John,


permanent link
Hadar Hawk (1881914) | answered Oct 11 '12, 2:24 p.m.
FORUM MODERATOR / JAZZ DEVELOPER
edited Oct 11 '12, 3:17 p.m.
Hi John,
For CLM 3.0.1,The  DOORS product is completely separate.  You need to run the DOORS help too. 

Are you all set with the help?

Thanks.
Hadar



permanent link
Alex Fitzpatrick (5583716) | answered Oct 19 '12, 2:58 p.m.
JAZZ DEVELOPER
edited Oct 19 '12, 4:31 p.m.
 The basic question asked was: "Could you please confirm if it is correct?"

The short answer is no, but they are good enough.

The required steps are:
1. Copy clmhelp.war from [RTC server install]\server\tomcat\webapps to [tomcat for help server]\webapps
2. Copy dwa-help.war from [Doors server install]\server\webapps to  [tomcat for help server]\webapps

These two servlets should already contain the documention for the products that you installed.

The info center servlet is distributed as a part of various products with different names and content. As mentioned in the IC you linked it is also available as a downloadable stand alone servlet help.war. However this seems to be a more recent version and I confirmed that I was unable to add content using the update site zips. (It does work with content from our servers when an internet connection is available.)

I found I was able to add the DOORS documentation to the CLM help servlet using the update site zip.

Your answer


Register or to post your answer.