Establishing Support Structure › Enabling the CAPA Help

Enabling the CAPA Help

CA Productivity Accelerator (CAPA) provides context-sensitive in-application performance support for the CA SDM analyst web forms. The CAPA player package directly integrates with the Context Help menus of CA SDM analyst web pages. The integration of CAPA Help content with CA SDM is achieved through the help menu scripts. These scripts launch the CAPA recorded Help content from the CA SDM Help menu drop-downs and right-click context help.

Note: This topic does not include information about the CAPA recording tool, obtaining and configuring the CAPA Help content, and installing the Smart Help.

CA SDM provides a unique identifier to recognize each web form uniquely. If an identification element is present in the top frame of the CA SDM, then the CAPA recording tool can recognize a web application form. Once the top frame is recognized, then all sub frames are considered to be part of this application. The sub frames that are loaded from a different domain must also be identified; otherwise, they are not considered part of the CA SDM. To enable the CAPA help, you are required to prepare the help content and then configure the options to launch the CAPA help.

Note: To customize the HTML files, use the invoke methods from the ias_helper.js files for the CAPA recorder to recognize the html forms.

CAPA Help is not supported on the CA SDM Employee, Customer, or PDA interfaces. For more information about the browsers that support CAPA, see the CAPA documentation.

Follow these steps:

1. Open the capa.properties file from the following CA SDM directory:

   %NX_ROOT/bopcfg/www/wwwroot
   

2. Change the following values in the file:
   • Enable_Alerts = 0. This option verifies and displays the javascript alert messages in a browser console when the CA SDM web page loads.
3. Save the file.
4. Go to the web.cfg file in the CA SDM directory, add DebugScript=1, and restart the web engine.

   The recorded content is prepared, published, and deployed on the CAPA server.

5. Open the capa.properties file and change the following values:
   • Enable_For_Recording = 0
   • Show_Learn_Links = 1. This value displays the CAPA Help option in the CA SDM Help Menu and in the right-click Help context menu.
   • Server_Name = name of the server where CAPA published content is deployed.
   • Server_Port = CAPA server port where the CAPA published content is deployed. For example, the TOMCAT port.
   • Virtual_Dir = virtual directory where the CAPA published content is deployed on the CAPA server.
   • Namespace = application context namespace. For example, app.SDM.Project123;en.
   • Enable_Alerts = 0
6. Save the file.

   You are ready to launch the CAPA Help from the CA SDM analyst web forms.