CA Productivity Accelerator v11.1 Help Menu Integration

Size: px

Start display at page:

Download "CA Productivity Accelerator v11.1 Help Menu Integration"

Thomas Fisher
5 years ago
Views:

CA EDUCATION INSTRUCTIONS: CA PRODUCTIVITY ACCELERATOR CA Productivity Accelerator v11.1 Help Menu Integration Table of Contents CA Productivity Accelerator Help Menu Integration Overview.

1 CA EDUCATION INSTRUCTIONS: CA PRODUCTIVITY ACCELERATOR CA Productivity Accelerator v11.1 Help Menu Integration Table of Contents CA Productivity Accelerator Help Menu Integration Overview... 2 CA Clarity PPM/CA ecogovernance In-Application Overview... 3 Prerequisites:... 3 Procedure for CA Clarity PPM v13/ecogovernance 3.1:... 3 Procedure CA Clarity PPM v12:... 4 SmartHelp Browser Support Overview SmartHelp Installation Instructions Configure SmartHelp SmartHelp Installation Requirements for Internet Explorer Install SmartHelp for Internet Explorer Troubleshooting Upgrade SmartHelp Uninstall from Internet Explorer Install SmartHelp for Firefox General Troubleshooting Tips... 13

2 CA Productivity Accelerator Help Menu Integration Overview CA Productivity Accelerator is a collaborative content development platform that allows enterprises to drive user productivity and mitigate risk throughout all phases of the software ownership lifecycle. CA Productivity Accelerator provides enhanced object recognition and context-sensitive support for the following CA Applications. In some cases, in-application support is provided with help integrated within the application. For other applications the SmartHelp browser add-on may be necessary. In-Application Support Application Versions Supported CA Clarity PPM 12.x, 13, 13.1 CA ecogovernance 3.1 CA Service Desk Manager 12.5* SmartHelp Browser Support Application Versions Supported CA Service Desk Manager 12.6, 12.7 Other CA browser-based solutions various Recording and In-Application/Browser Support Recording o o o Recording with object recognition and automatic context capture is supported for the following: Microsoft Internet Explorer for Windows versions 8.0 and 9.0 (32 bit and 64-bit versions) Mozilla Firefox for Windows version 10.x (ESR) Application/Browser Support In-Application Support is supported for the following: o Microsoft Internet Explorer for Windows versions 8.0 and 9.0 (32 bit and 64-bit versions) o Mozilla Firefox for Windows version 10.x (ESR) and 14 o Google Chrome for Windows version 20 o Apple Safari for Windows versions 5.0 and 5.1 SmartHelp is supported for the following: o Microsoft Internet Explorer for Windows versions 8.0 and 9.0 (32 bit and 64-bit versions) o Mozilla Firefox for Windows version 10.x (ESR) and 14 Please see the CA PA Technical Specifications for supported operating systems and browser combinations. *Please contact CA Support for CA Service Desk Manager v12.5 help menu instructions. CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 2

3 CA Clarity PPM/CA ecogovernance In-Application Overview CA Productivity Accelerator provides context-sensitive in-application performance support material by adding a link to the application tool bar that integrates CA Productivity Accelerator s player package directly into the application. When a user clicks on this link CA Productivity Accelerator will recognize what page they are on in the application and only show those procedures that are applicable in the player package. The steps below will show you how to integrate CA Productivity Accelerator to the application. To Integrate Content Prerequisites: 1) Publish a player package from the CA Productivity Accelerator Developer. 2) Set up an http web server to host the player package. Move the player package to the web server and test that the player package can be launched from the web server. (a) If the web server name is myserver.acme.com and the folder where the player package resides is CA PA, then you can launch the player package by entering the following location in a browser: (b) If the player package is posted on the same web server as Clarity or ecogovernance, for instance a Tomcat application server, you would post the player package to a folder called CA PA in the clarity\custom directory. You will need to reference the niku application in the URL to launch the player package: 3) Ensure the appropriate security credentials are set up for users to access the web server and for the Clarity or eco Governance application server to be able to launch the player package on the web server. 4) If step 2 above can be executed by a user step 3 is complete. 5) Have access to the application server; including the ability to stop and start the niku services. 6) If you are using a weblogic or websphere application server; you will need to repackage the EAR file after making the modifications below. Procedure for CA Clarity PPM v13/ecogovernance 3.1: 1) Log into Clarity System Administration (CSA) CSA comes with the application installation. To get to CSA, you add the port number to the server name in the url using the following format: (Apache Tomcat) (IBM WebSphere) (Oracle WebLogic) After you get to CSA, login and accept the service agreement. Open the server by clicking the name and click Application and you will see the following page: CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 3

$package to a folder called capa in the clarity\webroot directory you will need to reference the niku application in the URL to launch the player package: (ex: http://<server$

4 2) Modify the CA Productivity Accelerator URL by updating the field value in CSA If the player package is posted on the same web server as Clarity or eco Governance: a) If you posted the player package to a folder called capa in the clarity\webroot directory you will need to reference the niku application in the URL to launch the player package: (ex: Name>/niku/capa/stdhemi/hint_gateway.html). If your player package is posted on a web server that is different than the web server that Clarity or ecogovernance uses: b) If the player package resides in a folder called capa, then the value of the CA Productivity Accelerator URL should be Name>/capa/stdhemi/hint_gateway.html 3) Test your CA Productivity Accelerator link from the application a) Log into the application and you should see a link called Learn on the header of the application. Click on the Learn link and your CA PA application should display: Procedure CA Clarity PPM v12: 1. Add the custom icons named GlobalCapa.gif, GlobalCapaMo.gif, and GlobalCapaStd.gif to %CLARITY_HOME%/webroot/ui/evolution2/images/ folder. 2. Add the custom icons named GlobalCapa.gif, GlobalCapaMo.gif, and GlobalCapaStd.gif to CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 4

xsl (Note that you will need to change the webserver/port.

5 %CLARITY_HOME%/webroot/ui/evolution1/images/ folder. 3. Add the following to %CLARITY_HOME%/META-INF/union/vxsl/header.xsl (Note that you will need to change the webserver/port. Also, if you aren t using multiple languages you can remove the {$UserLanguage variable. Otherwise that translates to a directory of en by default. Insert the following highlighted text after the existing help action.) CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 5

6 <action id="btnhelp" type="image" actionid="union.help"> <image src="globalhelp" type="gif" highlight="true" width="16" height="16"> <tip value="help"/> </image><event id="showhelp"> <data id="topic" value="{$helpid}"/> </action> <action id="btncapa" type="image" actionid="union.help"> <image src="globalcapa" type="gif" highlight="true" width="16" height="16"> <tip value="capa" xml:lang="en"/> </image> <xsl:choose> <xsl:when test="$uiskin = 'evolution1'"> <event id="openwindow"> <data value=" dandparams}"/> </event> </xsl:when> <data value="help"/> <xsl:otherwise> <event id="openhelpwindow"> <data value=" dandparams}"/> </event> </xsl:otherwise> </xsl:choose> </action> <action id="btnlgout" type="image" actionid="security.logoutaction"> <image src="globalexit" type="gif" highlight="true" width="16" height="16"> <tip value="logout"/> </image> </action> CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 6

7 Note: Your site will have a unique web address set for the value properties in the script above. We are showing an example of integrating a player package directly into an Apache Tomcat server where Clarity resides in the webroot under capa/{$userlanguage} (data value=" emi/claritygateway.html?topic={header/action/@idandparams}"/>). Value Property Breakdown: 4) If you are on Clarity version 12, the following code is in place and as such you can skip to step 5. If you are on Clarity version 8.x, add the openhelpwindow Javascript function (exists in 12.0 but not in 8.x) to the %CLARITY_HOME%/webroot/ui/evolution2/js/LinkActions.js file function openhelpwindow(actionid) { this will equal the server and port where you have put the player package. It can be the same server as Clarity or a different server altogether. If no port is mentioned; default port 80 is used. /niku/ if you are placing the player package on the same server as Clarity you will need this folder in the address. /capa/ this is the folder you have created to store your player package(s) on the web server. {$UserLanguage} Optional. This is used if you have multiple player packages (one for each language you are supporting). This variable will guide the user to their default language player package. /clarity/hemi/claritygateway.html?topic={header/action/@idandparams} this passes what var url = actionid; var args = openwindow.arguments; var prop = ""; var width = -1; var height = -1; var windowname = "niku"; var top = (screen.height-height)/2; var left = (screen.width-width)/2; prop += ",width=" + width + ",height=" + height + ",top=" + top + ",left=" + left; closeallchildwindows(); _childwindow = window.open(url, windowname, prop); _childwindow.focus(); } CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 7

$Open %CLARITY_HOME%\resource\union_view_en.$

8 5) For both 8.1 and v12, you need to update the union resource view file to properly display CAPA on mouse over. Open %CLARITY_HOME%\resource\union_view_en.properties in a text editor. CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 8

the EAR file. 7) Log back into Clarity and clear the Security Cache.

9 Navigate to the bottom of the file and add the following line then save: CAPA=CAPA 6) If you are using Weblogic or Websphere rather than Tomcat, you will need to re-package the EAR file. 7) Log back into Clarity and clear the Security Cache. After the = sign, type security.caches. CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 9

10 8) Go to the Group Tab. Flush the VXSL cache. Log into Clarity and test the new button. SmartHelp Browser Support Overview The integration of CA PA into any browser based CA solution has been streamlined into one method using SmartHelp. SmartHelp is accessible at all times using either the SmartHelp toolbar button or F9 function key. SmartHelp Installation Instructions For browser-based applications, the SmartHelp toolbar button can be used to deploy performance support. SmartHelp can be used for context-sensitive ExactMatch or SmartMatch content for various CA applications. The processes are the same for both technologies to Implement SmartHelp. Obtain content - This is a Player package that an author created and published from the Developer to a webserver Install SmartHelp - Deploy the link for installing SmartHelp to your end users. Configure SmartHelp When you record browser-based application content, the content is automatically ready for deployment with the SmartHelp toolbar button. You can host the published content on a web server and install SmartHelp from the hosted content location. Other than deploying SmartHelp to end users, there is no content configuration required. Note: If you have content created in different versions of the CA PA developer, SmartHelp should be installed and configured from the latest version. An older version of SmartHelp must not point to content from a newer version. CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 10

11 SmartHelp Installation Requirements for Internet Explorer The user who installs, configures, and uninstalls SmartHelp must have administrator rights to the local computer. Medium or medium-low security is recommended for the published content. In the Security tab, Local Intranet and Trusted Sites have the recommended security levels. For SmartHelp to work properly, the following settings should be as follows: Download signed ActiveX controls: Enable or Prompt Run ActiveX controls and plug-ins: Enable Script ActiveX controls marked safe for scripting: Enable Note: If Internet Explorer and the operating system have Protected Mode support, the content locations and applications used with SmartHelp must have the same Internet Explorer mode, either Protected or Unprotected. Install SmartHelp for Internet Explorer An ActiveX control must be installed on the end-user system to enable the SmartHelp for Internet Explorer. A key feature of ActiveX controls is their simple download and execute deployment model. Users can install SmartHelp by accessing the following page from Internet Explorer: In Windows Operating systems at least Power User or higher (Administrator) privileges are necessary for installation. System administrators may need to modify permissions for users or applicable groups. It is recommended that URL for SmartHelp is part of an Internet Explorer security zone that is equivalent to either Low or Medium-low pre-defined settings. CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 11

12 Troubleshooting When the SmartHelpsetup.html page displays an error, additional information is available by appending?diagnosticmode to the URL. For example: mode In most cases, after you restart the browser the new toolbar button will appear automatically. However, if the user has customized the Internet Explorer toolbar, the new button may not appear. In this case, the toolbar button is added to the choices in the Customize Toolbar dialog box, and it will appear if the toolbar is reset. For more information, see the article on the Microsoft Developer Network at Depending on the version of Internet Explorer you are using, the entire toolbar may not display. The SmartHelp button will be added in the dropdown list area for more buttons. Upgrade SmartHelp If the published content on the server is refreshed or upgraded, the new content could contain a newer SmartHelp version with newer resources. The SmartHelp button from the previous version cannot load the newer content. For SmartHelp to upgrade itself, the user must launch the setup. If SmartHelp does not work after a browser upgrade, the setup page can be launched to upgrade or reconfigure it. Uninstall from Internet Explorer Find the SmartHelp Helper bho (currently loaded add-ons) and disable it Restart the browser Find the SmartHelp activex (downloaded controls) and remove it Restart the browser. Install SmartHelp for Firefox An administrator needs to add the.xpi and.jar MIME types before the SmartHelp button can be installed on Firefox. Users can install the toolbar button by accessing the following page from the Firefox browser: When installation is complete, users must use the Restart Firefox button in the Add-ons dialog box or the button will not be configured properly. Users may then need to add the button to their toolbar with the Customize option. To successfully install the SmartHelp button on Firefox, the location of the deployed content must be added to the addon exception list. For more detailed instructions reference the In-Application Support.pdf located in your CAPA installation folder under \Documentation\EN\Reference. CA EDUCATION PRODUCT INFORMATION: CA PRODUCTIVITY ACCELERATOR 12

General Troubleshooting Tips Problem The player package opens and immediately closes. There is a warning or error that mentions trusted sites for the zone the user is in.

13 General Troubleshooting Tips Problem The player package opens and immediately closes. There is a warning or error that mentions trusted sites for the zone the user is in. The player package will not launch from a second screen when using dual-monitors that appear as one contiguous large screen. The player package and the DoIt! Mode will not work. Do It mode won t launch and an error appears that relates to setting the size and position. The CA PA button on the toolbar disappears when moused-over. Solution Ensure the pop up blockers for that site are disabled. Add the website to the list of trusted sites in the internet security options settings. Launch both the browser and Clarity (and therefore CAPA) from the primary screen. Enable the JavaScript on the browser. Go to Tools, Options in Internet Explorer, click on the security folder and the custom level button and enable the option mentioned in the error message. Ensure the graphics mentioned in step 1 and 2 are copied into the aforementioned image folders. To learn more about how CA Education is dedicated to providing you with flexible learning options based on your budget, travel and knowledge transfer requirements go to your regional Education section of ca.com. C opy rig h t C A. A ll rig h t s re s e r v e d. A l l tradem a rk s, t ra d e n a m e s, s e r v ice ma rk s a n d log os refe re n c e d h e re i n b e l o n g t o t h e i r r e s p e c t iv e c omp a n ie s.

Browser Guide for PeopleSoft

Browser Guide for PeopleSoft Business Process Guide For Academic Support Specialists (Advisors) TABLE OF CONTENTS PURPOSE...2 INTERNET EXPLORER 7...3 GENERAL TAB...4 SECURITY TAB...6 PRIVACY TAB...10 CONTENT