Solutions

Providing locally installed help for Application Repository, Work Center, and Application Administrator



ID:    S143611
Published:    17 December 2021

Product(s)

  • SBM
 

Description

 As of SBM 10.1.5, the Application Repository help links direct you to the Doc Center (help.serena.com).  This also applies to the help links in Serena Work Center.  For customers that cannot access the help server, but still need access to the Application Repository and Work Center help, the help can be installed locally.

 
As of SBM 11.4, the Application Administrator help links direct you to help.serena.com.  Follow the steps below to install the Application Administrator help locally.
 
These instructions will work for SBM 11.4.2 and later.  Start by downloading the help documentation for your version of SBM from this KB.  If you do not see your version then contact support and request files for your version.

Resolution

Application Repository Help: Install Locally

To change the help call in Application Repository, perform the following steps:
 
1. Contact the SBM Doc team and request the ar_help.zip that matches your version of AR.
2. Unzip the ar_help.zip to create the following directory on your AR/Tomcat server:
[SBM INSTALL DIR]\Common\tomcat\server\default\webapps\serena-help\console\ar_help
3.  Navigate to the help.js file located here:
[SBM INSTALL DIR]\Common\tomcat\server\default\webapps\mashupmgr\js
4.  Open the help.js file, and then search for the following entry.  If you are using IIS to proxy all requests use port 80/443 instead of 8085.
function processHelpRequest()
{
 var url = "http://help.serena.com/doc_center/sbm/help.html";
Replace the DOC center URL with the URL for the help files on your AR server.  For example:
function processHelpRequest()
{
 var url = "http://AppRepositoryServerName:8085/serena-help/console/ar_help/help.html";
5.  Restart SBM Tomcat
 
6.  Click the Help link in AR to verify that the local help system is now available.
 
 
Work Center Help: Install Locally
To change the help calls in Work Center, perform the following steps:
 
1.  Contact the SBM Doc team and request the work_center.zip that matches the customer's version of Work Center.
 
2.  Unzip the work_center.zip to create the following directory on your AE server:
[SBM INSTALL DIR]\Application Engine\bin\work_center
3.  Navigate to [SBM INSTALL DIR]\Application Engine\template\shell\swc\swc, and then edit the userSetting.html file.  Modify the help.serena.com URL as follows (use your AE IIS server host name):
<a href="javascript:void(0);" onclick="window.open('http://AEserverName/workcenter/work_center/help.html', 'WorkCenterHelp', 'location,menubar,resizable,scrollbars,toolbar')">
          $SLS(swc.userSettings.help, Help,TT_HTML) 
4.  Navigate to [SBM INSTALL DIR]\Application Engine\template\shell\swc\swc\help, and then edit the generalHelp.html file.  Modify the help.serena.com URL as follows (use your AE server host name):
<a href="javascript:void(0);" onclick="window.top.open('http://AEserverName/workcenter/work_center/help.html', 'WorkCenterHelp', 'location,menubar,resizable,scrollbars,toolbar')
5.  Open SBM System Administrator and perform a Put Files in Database operation.
 
6.  Restart IIS.
 
7.  Test the help links on the main dashboard page and in the user settings menu.
 
Application Administrator Help: Install Locally
To change the help calls in Application Administrator, perform the following steps:
 
1.  Get the web_admin.zip that matches your version of SBM.
2.  Navigate to [SBM INSTALL DIR]\Application Engine\bin\web_admin_help, and then edit the mapping.properties file. 
3.  Modify the helpdir entry as follows (use your AE server host name):
helpdir=http://AEserverName/tmtrack/web_admin_help/index_CSH.htm#
4.  Extract the web_admin.zip to [SBM INSTALL DIR]\Application Engine\bin\web_admin_help.
5.  Reload SBM Application Administrator and test a help call by clicking Help under your user name. 
 

Applies To

SBM

Attachment

File NameFile SizeDownLoad
SBM118_DOC.zip 40.5MB HTTP
SBM1171_DOC.zip 37MB HTTP

Rate this Solution

Find Answers

Type a question or describe what you are looking for below

My Recent Searches

Welcome kb sso

Additional Assistance

  • Submit a Case Online
  • FAQs