Install Guide- CMaps Analytics Extension for WebI

RequirementsAdmin FAQWhere to DownloadVideoInstall Tutorial BI4.1 SP6- BI4.2 SP2Install Tutorial BI4.2 SP03 and HigherUpgradeEnable in CMCAprove DomainsLicense KeysLifecycle ManagementUn-InstallTroubleshooting
[post-content id=3963]

Q: Where do I enter/ define my license key?
A: Your account has an assigned key, which is automatically injected into CMaps Analytics Webi extension JAR at the time of download. Your authentication key is installed in the resources folder of the JAR and used to identify your organization. This public authentication key is utilized to log page views.

Q:  How is CMaps Analytics integrated with Webi?
A: CMaps Analytics JAR is compiled directly from an SAP provided and supported SDK (Webi ExtensionPoints), and uses only supported APIs documented by SAP. However, adding and removing JAR files from a running Java App server like Tomcat, could impact the server if manually edited or removed without properly stopping your app server. Please review the upgrade / un-install directions.

Q: Does CMaps Analytics extension require additional servers or modification of existing files in BusinessObjects?
A: CMaps Analytics extensions does NOT require modification or over-writing any existing files in your BusinessObjects environment.

Q: Does the CMaps Extension for Webi need to be installed only on Development Environment?, or on ALL (DEV, TEST, PROD) BI4.1 Environments?
A: The Webi extension should be installed on all environments. SAP Webi extension points serves up standard SAP APIs along with CMaps Analytics APIs.

Q: Once installed, does the access to Webi Extension need to be restricted to the people who have CMaps Dashboard Developer licenses allocated? Or can anyone who has rights to use Webi can also use CMaps Extension?
A: There are no named user requirements for Webi users. Technically, any Webi user who can edit or view a Webi report can use the CMaps extension. Report end users can also consume Webi reports too with no additional license required. Where the named user “Designer/Developer” license comes into play is using CMaps Analytics Designer which is where you build custom maps templates that don’t come out of the box and are more custom designed for specific business requirements.

Q: Can access to the map be restricted?
A: As an administrator you can restrict access to CMaps Analytics based on their BusinessObjects enterprise user group membership. If a map is not connected to data, clicking on the icon will simply open a blank Google Map (will not count against your annual page views).

Q: Can I add more default templates to CMaps Analytics extension?
A: This is technically possible but not currently supported features.

Q: How does user / data security work with the maps are connecting to the web?
A: CMaps Analytics does not transmit any data displayed on top of the Google Map. Please review the included security guide which explains how CMaps Analytics APIs and Google Maps ensure that your data is protected: http://cmapsconnect.com/security/

Where to Download CMaps Analytics Designer

[post-content id=3816]

Video Instruction

The following install guide can be used with BI4.1 SP06 up until the latest version of BusinessObjects BI4.2. This process, uses a single JAR file that is installed onto your SAP BusinessObjects Application Server.

Install CMaps Analytics Extension JAR File in BOE

Important note for un-install- Prior to installing please review the un-install process to ensure you and your server administrator are aware of un-install steps.

Roles needed: The following steps require a server administrator.

Per the SAP BusinessObjects Web Intelligence SDK documentation and supported guidelines, the following install instructions will enable a new Web Intelligence Extension for CMaps Analytics that can be managed within the CMC.

Step 1 GET THE LATEST EXTENSION

Step 2 Unzip the JAR file called “com.businessobjects.webpath.AnalyticalReporting_Centigon_CMapsAnalytics.jar”

Step 3 Stop your Apache Tomcat Server.

NOTE: It is extremely important that you stop your Apache server prior to installing any WebI Extension points.

Step 4: Copy the JAR file com.businessobjects.webpath.AnalyticalReporting_Centigon_CMapsAnalytics.jar to the following directories on your SAP BusinessObjects instance.

[SAP Business Objects Install Directory]\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps\BOE\WEB-INF\eclipse\plugins\

 

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\

 

[BusinessObjects Web Application Install Directory]\tomcat\work\Catalina\localhost\BOE\eclipse\plugins\

 

TROUBLESHOOTING NOTE: In many Windows install scenarios when Tomcat is stopped, if it is not properly shut down or if there are any other errors, it may re-start without refreshing the Tomcat cache. A quick way to ensure the cache is clear on startup is to delete the cache files. To do this:

Step 5: Clear Tomcat Cache

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\work\Catalina\localhost\BOE\eclipse\configuration

 

Remove all the content inside of the configuration folder  EXCEPT config.ini file. Please ensure that you do NOT to delete the file: “config.ini”. This will clear the cache and likely resolve any conflicts during an upgrade or an event where the extension is not visible.

Step 6: Re-start your Tomcat server

[post-content id=8604]

Update or Upgrade Extension JAR File

GET THE LATEST EXTENSION

With the latest extension JAR file, you are going to overwrite your JAR on the server.

Step 1 Stop your Apache Tomcat Server.

Step 2: Copy the JAR file com.businessobjects.webpath.AnalyticalReporting_Centigon_CMapsAnalytics.jar to the following directories on your SAP BusinessObjects instance.

[SAP Business Objects Install Directory]\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps\BOE\WEB-INF\eclipse\plugins\

 

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\

 

[BusinessObjects Web Application Install Directory]\tomcat\work\Catalina\localhost\BOE\eclipse\plugins\

 

Step 3:

Remove all the content inside of the configuration folder  EXCEPT config.ini file. Please make sure NOT to delete the file: “config.ini”. This will clear the cache and likely resolve any conflicts during an upgrade or an event where the extension is not visible.

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\work\Catalina\localhost\BOE\eclipse\configuration

 

Step 4: Start your Tomcat server

Enable the Webi Extension Point in CMC

Roles needed: The following steps require someone who administrates SAP BusinessObjects through the CMC.

Step 1: Log into the SAP BusinessObejcts CMC

Step 2: Select User Groups

Step 3: Select the user group you want to enable your extension point for.

Step 4: Right click and select “Customization” from the menu

admin

Step 5: Within the Customization menu, select the “Extensions” tab.

Step 6: Select the CMaps Analytics extension

Make sure you check the box to enable the extension. Otherwise it wont be avaialble in Webi

Step 7: Click Save and Close

Capture

Step 8: Upon opening a WebI Document you will now see the CMaps Analytics extension.

Now you are ready to configure your CMaps Analytics view inside of your report! Configuring your CMaps Analytics in WebI. These steps can be completed by anyone in your organization with rights to publish content to the repository and edit Web Intelligence reports.

Capture

Whitelist Domains for Access to Google Maps

boe

After installing CMaps Analytics Extension you will also need to approve your domain for use with Google Maps. This is an additional security measure required by Google to protect un-authorized use of your maps license or authentication keys on servers not owned or maintained by your organization. The domain / or IP address you use to BI LaunchPad is what you will capture and submit to Centigon Support or to support@cmapsanalytics.com and our staff will add your domain.

Approve your Domains

Oops! We could not locate your form.

License Keys

To simplify the solution architecture, reduce support, and ensure a scalable enterprise solution, license keys are automatically embedded inside of the CMaps Analytics JAR when you download from CMaps Analyitcs Designer.

Inside of each JAR extension is your license / authentication key. No additional configuration is required to import or update keys.

Lifecycle Management

You will need to install the same CMaps Analytics extension (JAR) on each of your BOE environments. For individual reports containing maps, there is no steps required to migrate maps enabled reports between reports.

When a report designer creates a map in Webi, all of the metadata generated is stored within a Webi variable:

lifecycle

Uninstall an Extension

Please carefully read all un-install steps for extension points provided by SAP

Step 1: Log into the SAP BusinessObjects CMC

Step 2: Select User Groups

Step 3: Select the user group you want to disable your extension point for.

Step 4: Right click and select “Customization” from the menu

admin

 

Step 5: Within the Customization menu, select the “Extensions” tab.

Step 6: De-Select the CMaps Analytics extension

Step 7: Click Save and Close

Capture

Step 8 – Stop Tomcat.

Step 9 – Remove the jar file for the CMaps Analytics extension.

[SAP Business Objects Install Directory]\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps\BOE\WEB-INF\eclipse\plugins\

 

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\

 

[BusinessObjects Web Application Install Directory]\tomcat\work\Catalina\localhost\BOE\eclipse\plugins\

Step 10– Navigate to the directory containing your saved Eclipse Configuration Data:

Step 11: Clear Tomcat Cache – This is not required but is helpful in case if you decide to re-install CMaps at a later date.

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\work\Catalina\localhost\BOE\eclipse\configuration

 

Remove all the content inside of the configuration folder EXCEPT config.ini file. Please make sure NOT to delete the file: “config.ini”. This will clear the cache and likely resolve any conflicts during an upgrade or an event where the extension is not visible.

Step 12 – Restart Tomcat.

Troubleshooting

Component does not show up in the CMC tab

Capture

Make sure you placed the JAR file in all 3 directories specified in 3 directories specified above.

After enabling the component, the extension shows a 404 error

If you were emailed the JAR file, it is possible that common email programs will strip out files, specifically index.jsp from the JAR. The best course of action is to download the zip / JAR file directly from CMaps Analytics Designer

Component does not work after loading:

After an install or upgrade of CMaps Analytics extension, the component does not operate as expected.. Component freezes, binding buttons don’t work, saving does not work, etc:

This could be browser caching: Clear your browser cache

Instructions for IE

Instructions for Chrome

This could be server side caching: The cause is when tomcat is not stopped and the JAR file is replaced. The fix is to simply clear the Tomcat cache:

Step 1- Stop Tomcat (required)

Step 2– Navigate to the directory containing your saved Eclipse Configuration Data:

[BusinessObjects Web Application Install Directory]\SAP BusinessObjects\tomcat\work\Catalina\localhost\BOE\eclipse\configuration

Step 3- Remove all the content inside of the configuration folder listed in Step 10 except config.ini file. Please make sure NOT to delete the file: “config.ini”

Step 4- Restart Tomcat.