OD CABI 3.2 Connectivity Guide

V1.0

Authors: Kelly Limberg, Shawn Moore

On Demand Business Objects

Connectivity Guide for CABI 3.2

Legal

Copyright © 2013 CA. All rights reserved. All trademarks, trade names, service marks and

logos referenced herein belong to their respective companies. This document is for your

informational purposes only. To the extent permitted by applicable law, CA provides this

document “As Is” without warranty of any kind, including, without limitation, any implied

warranties of merchantability or fitness for a particular purpose, or non-infringement. In no

event will CA be liable for any loss or damage, direct or indirect, from the use of this

document including, without limitation, lost profits, business interruption, goodwill or lost

data, even if CA is expressly advised of such damages.

Contents

Contents Legal .......................................................................................................................................................... 2

Contents ........................................................................................................................................................ 3

Chapter 1: Introduction ................................................................................................................................ 5

Purpose ..................................................................................................................................................... 5

Definitions ................................................................................................................................................. 5

Chapter 2: Report Development ................................................................................................................... 7

Database Access ........................................................................................................................................ 7

BusinessObject Access .............................................................................................................................. 7

WEBI and InfoView ................................................................................................................................... 7

Business Objects Designer ........................................................................................................................ 8

Crystal Reports .......................................................................................................................................... 8

Chapter 3: InfoView .................................................................................................................................... 11

Prerequisites ........................................................................................................................................... 11

Access ...................................................................................................................................................... 11

Overview ................................................................................................................................................. 11

Chapter 4: Web Intelligence ....................................................................................................................... 12

Prerequisites ........................................................................................................................................... 12

Access ...................................................................................................................................................... 12

Simple Test Report .................................................................................................................................. 13

Chapter 5: Oracle Client Install ................................................................................................................... 16

Installing an Oracle Client ....................................................................................................................... 16

Configuring your TNSNAMES.ORA file .................................................................................................... 20

Chapter 6: BusinessObjects Designer ......................................................................................................... 21

Installation Instructions .......................................................................................................................... 21

Prerequisites ....................................................................................................................................... 21

Installation Steps ................................................................................................................................. 21

Configuration .......................................................................................................................................... 25

Connecting to CA OnDemand ............................................................................................................. 25

Prerequisites ....................................................................................................................................... 25

Chapter 7: Crystal Reports .......................................................................................................................... 28

Prerequisites ........................................................................................................................................... 28

Test Connection from Crystal Report via Direct SQL .............................................................................. 28

Chapter 8: Deploying Custom Reports ........................................................................................................ 35

Introduction ............................................................................................................................................ 35

Deploying Reports through InfoView ..................................................................................................... 35

Deploying Reports through the Central Management Console ............................................................. 36

Deploying Crystal Reports in Clarity........................................................................................................ 36

Setup New Report definition in Clarity ................................................................................................... 39

Chapter 1: Introduction

Purpose The purpose of this document is to provide an overview of the configuration and definitions of the

reporting capabilities provided as part of the On Demand service. Guidance is provided on how Business

Objects (BO) components are configured to work with On Demand environments. This guide is not

intended to provide training on the usage of BO tools but only on the connection of those tools to an On

Demand environment

Definitions Business Objects (BO): Enterprise software built on a service-oriented architecture, the software offers

an extensive set of reporting solutions on a single platform.

Web Intelligence (WEBI): Self-service access to data and intuitive information analysis available in one

product helping users create a query from scratch, format the retrieved information, and easily analyze

it to understand underlying trends and root causes. And if they don't require the full power of query

capabilities, users can simply explore information in existing reports – formatting and interacting with

data to meet specific needs

InfoView: As a standalone BI portal, InfoView can easily integrate with popular enterprise information

portals. You can personalize how you view, manage, and distribute BI content. For example, one can set

the default universe be displayed in BO designer through InfoView.

This tool is available at: https://<RPTSERVERURL>/InfoViewApp , where < RPTSERVERURL > will typically

follow the convention of <yourservername>rpt.ondemand.ca.com.

i.e. https://cppm0000rpt.ondemand.ca.com/InfoViewApp

Crystal Reports: Connect to virtually any data source, design and format interactive reports, and share

them internally and externally. Crystal Reports can be connected to the existing BO environment for

developing any reports based on universe or just tables. Connectivity is shown below.

Central Management Console (CMC): Maintains info on security, objects and servers in BOE XI DB.

Custom universes are deployed using CMC. This tool is available at https://<RPTSERVERURL>/CmcApp,

where < RPTSERVERURL > will typically follow the convention of

<yourservername>rpt.ondemand.ca.com.

Designer: Used to create and maintain custom Universes.

Universe: A set of metadata that describes what’s in the CA Clarity PPM On Demand database and/or

data mart. It can be used for the creation of WEBI (ad hoc) and Crystal Reports.

TNS Entry: Add the TNS entry with the name “niku” in the tnsnames.ora file under the oracle client directory. This should be named “niku” for BusinessObjects Designer, or Crystal Reports Designer. For BO Designer, it should match that of the Clarity instance, as it is passed along with the connector when importing/exporting the universe. If it doesn’t match when importing, you will get an error. If it doesn’t match when exporting back, it can change the connection that all reports use, thus breaking reports in Clarity. As for Crystal Reports, this should always be “niku” regardless of the actual SID from the system. Example: TNS entry may be niku, but the sid may be niku2, niku3, etc….

The directory structure should be similar to

C:\Program Files\Oracle\Ora92\Network\Admin\tnsnames.ora

or

C:\oracle\product\11.2.0\dbhome_1\Network\Admin\tnsnames.ora

Chapter 2: Report Development

CA Clarity PPM On Demand provides for standard Business Objects (BO) reporting capabilities to enable

clients to create and maintain custom reports. This reporting functionality is provided through the usage

of three BO utilities: 1) InfoView 2) Web Intelligence (WEBI) and 3) BusinessObjects Designer. A limited

set of functionality from these tools is supported, as described below, in addition to enabling reporting

within the Clarity application. If a particular Business Objects Enterprise suite functionality is not

described below, it is not available or supported as part of the Clarity On Demand service.

On Demand provides access to these tools but does not provide any training to support their usage.

Users are expected to have a level of education and familiarity with the BusinessObjects tools to be used

commensurate with the activities they intend to perform. If a client requires training for these tools CA

recommends they reach out to SAP or a third party education provider. Optionally, the client may

contract with CA Services to provide for report generation and support.

Database Access If a client requires the ability to generate their own custom reports, they must open a CA Support ticket

to obtain read-only access to their databases; if a CA Project Manager is engaged they may request the

access for the client. After On Demand receives the access request a read only database user will be

created along with a VPN connection to the database server. There is a limit of 6 active VPN accounts

per client.

BusinessObject Access For a user to run a report from Clarity they must have a corresponding user in BusinessObjects. Basic

users are created by running the “Create BusinessObjects users” job from within Clarity. However in

order to access the advanced components such as BusinessObjects Designer to create custom universes

or Crystal Reports to create custom reports, you need to open a ticket with CA OnDemand Support and

request a BusinessObjects user be added to the “CA Reports Admin” group for your organization. This

will allow access to advanced components in InfoView and the BusinessObjects Central Management

Console (CMC).

WEBI and InfoView Once the client has access to InfoView and WEBI, they can be utilized to generate ad hoc reports and

upload custom reports to Clarity in a self-service manner. The types of reports created by WEBI are

generally simple in nature and based off BO universes. These users accessing this functionality should be

trained in using WEBI. Improper ad-hoc reporting has the potential to impact performance across the

entire application.

NOTE: InfoView functionality is only supported to the extent described in this section. Standard,

recurring reporting should be run or scheduled from the Clarity application.

Business Objects Designer The client can alter and create universes via BusinessObjects Designer. The BusinessObjects Designer

tool is available to a client as part of the CA Clarity PPM On Demand service. To obtain the tool the client

must open a CA Support ticket requesting access to the installation file.

Crystal Reports For clients that wish to create more sophisticated reports BO’s Crystal Reports tool can be utilized to

create reports with the database connection provided by On Demand. Crystal Reports license is

included as part of the CA Clarity PPM OnDemand service. A support ticket can be opened with

OnDemand support to request access to the SAP BusinessObjects Crystal Reports for CA Technologies

v2008 SP5 installation files. This is a separate installation file then the BusinessObjects Designer Client.

NOTE: Only reports packaged for InfoView deployment can be uploaded to an On Demand system

by the client. This requirement precludes certain types of reports requiring custom database objects

from being deployed. The On Demand team does not support or deploy any custom Crystal Reports

content or functionality.

FAQs

1. What kind of access rights tickets can be raised within Support.CA.com?

Report development: Users are given InfoView access and they can develop custom reports

through WEBI interface within InfoView. This type of access is limited to 10 users

Custom report and universe development: Users are given InfoView DB read only access (with

On Demand VPN access). The users can download universes, modify the universes within BO

designer and deploy them through Central Management Console. Users can also connect Crystal

reports to their On Demand environment via the VPN account. This type of access is limited to 6

users.

Download BusinessObjects designer: Users will be given the access/location of BusinessObjects

designer installable.

Download Crystal Reports: Users will be given the access/location of Crystal Reports installable.

NOTE: The Business objects downloads will be made available via the support case.

When downloading from the CA Support site please use the Full-Featured FTP client.

2. What kind of DB access can be granted?

Up to 6 users can be granted read only access to the environments. No other type of database

access is permitted.

3. Can the reports be dependent on custom Functions or Stored Procedures?

No. Custom database procedures cannot be supported by On Demand and, therefore, no reports

can be developed that utilize them. Any SQL code needed for a report needs to built into the report

or created as part of a custom universe.

4. Does On Demand support custom report issues?

Custom reports are not supported by On Demand. If you wish to have a custom report supported,

there must be a SSA (Supplementary Support Agreement) with CA Services Global Delivery. Please

contact your CA Account manager for more details.

5. What support can I expect from On Demand for reporting?

On Demand only supports reports and universes that are deployed with the standard solution. Any

altered stock report or universe along with any custom report or universe is not supported by CA.

On Demand does provide support for database connectivity via provided VPN accounts along with

InfoView, WEBI, and CMC accessibility issues.

6. To what extent does On Demand support connectivity?

On Demand will insure that:

The provided VPN credentials will authenticate and provide connectivity to the client’s

database servers

Oracle’s Net Manager will connect to the database

BusinessObjects Designer will connect to the database

InfoView, WEBI, and CMC URL’s will be available

7. I am not able to access the universe/tables from a BusinessObjects universe. What should be

checked?

Make sure the TNS names match the SID for that particular environment

8. Will On Demand deploy my custom reports or universes or move them from one environment to

another.

On Demand will not deploy any custom content nor move any custom content from one

environment to another. Refreshes of data from one system to another do not include Business

Objects custom content. In the case of disaster recovery, custom content will be restored along with

all other client data and configurations.

9. How to develop crystal reports for different environments?

Refer to section 8.5.1

10. How can a report developed in the Development environment be promoted to Test or Prod

environments?

Refer to section 8.5.1

Chapter 3: InfoView

Prerequisites 1. Access to InfoView is granted through an On Demand ticket. Refer to FAQs for more

information.

Access InfoView is available at: https://<RPTSERVERURL>/InfoViewApp , where < RPTSERVERURL > will typically

follow the convention of <yourservername>rpt.ondemand.ca.com.

i.e. https://cppm0000rpt.ondemand.ca.com/InfoViewApp

Overview InfoView provides an interface to view installed and executed reports, create new documents or add existing reports. Some of these features will be described in greater detail in the following sections.

Chapter 4: Web Intelligence

Prerequisites 1. WEBI is accessed through InfoView or CMC. Refer to chapter 1 or 3 for URLs for access to the

CMC or InfoView.

2. Access to WEBI and InfoView environment is granted through an On Demand ticket. Refer to

FAQs for more information.

Access To access WEBI from InfoView, follow these steps.

1. Access the InfoView URL and log in.

2. Click “Document List”

3. Click “New-> Web Intelligence Document”

4. Choose the universe that you would like to develop your report in.

5. Now you can drag and drop fields to create your report.

Simple Test Report Sometimes it is helpful to create a test report to verify that the environment is correctly running. Follow these steps to create a simple test report.

1. Complete steps 1-5 above.

2. Choose the CA PPM Investments – Oracle universe.

3. Expand the Investments folder, then the Projects folder.

4. Now drag Project Name and Start Date to the Result Objects window.

5. Click “Run Query” to execute the report.

6. If you have a high number of projects, you can also add a query filter, by dragging a field into the

Query Filter’s window and then choosing camparision criteria.

i.e.

7. After you run the query, you can save the document to a local location or onto you server under

particular Public Folder.

i.e.

Chapter 5: Oracle Client Install

Installing an Oracle Client The first step in preparing to connect with BusinessObjects Designer is making sure that there is an

Oracle database client installed on the user’s local machine. If a database client is already installed you

can skip over this section, if not please continue with instructions that follow.

1) Go to http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html

2) Choose the 32 or 64-bit Oracle client download relevant to the machine you are working on, as shown in the screenshot below. NOTE: Do not install the Oracle “Instant Client” which is a light weight client that does not include all the features and tools needed to run BusinessObjects Designer and Crystal Reports.

3) Click on See All link beside the installation you required.

4) For this example we have chosen the 32-bit client to install.

5) Accecpt the License Agreement and Download the file.

NOTE: If this is the first time you are downloading from the Oracle site, you are required

to sign-up for an Oracle Web account. Please follow the instructions you are presented

to create the account, then return to the above page and you will be able to download

the ZIP file.

6) Once installed Unzip the package to your Desktop and begin the installation of the client.

7) Double-click the Setup.exe file from unzipped archive.

8) Follow the on-screen instructions until you are presented with the splash-screen shown below. Users that are unsure about what tools they need should choose the Administrator option is as it installs all the included items in the installer.

9) Follow the remaing step to complete the install.

10) Once completed you can then configure your TNSNAMES.ORA file with the database connections BO

Designer will use to connect to user’s database.

Configuring your TNSNAMES.ORA file

1) The next step in connecting to use BO Designer is to configure your TNSNAMES.ORA file with

the connection details of the database you want to connect to.

2) Locate the TNSNAMES.ORA file on your system.

3) Depending on where you specified for the Oracle client folder to be placed during the installation process of the Oracle client, the following path should correspond to the location. For example: C:\product\11.2.0\client_1\network\admin

4) Open the TNSNAMES.ORA file and place the database connection entry as follows:

For example: niku = (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = <Server IP Address>)(PORT = 1521)) ) (CONNECT_DATA = (SERVICE_NAME = niku) ) )

NOTE: The standard Service name is “niku”

Chapter 6: BusinessObjects Designer

Installation Instructions

Prerequisites

1. Download the installation file. The file is obtained by requesting it via a CA Support case.

2. Please ensure adequate disk space on your local workstation. The ISO (Disk Image file),

extracted installation folder, and the program directory combined are approximately 16GB in

size.

3. Oracle Client 10g or above installed.

4. Access to database through On Demand ticket. Refer to FAQs.

Installation Steps

1. Download and extract the ISO Disk Image file to a location on your workstation. 2. Browse to the following location:

a. %system location%:\Disk1\cabi 3. Double click the “setup.exe” file to start the installation wizard 4. Select your preferred Language

5. Select “OK”

6. Note the on screen instructions and warnings, and choose “Next”.

7. Accept the license agreement and click “Next”

8. Select the desired languages and click “Next”

9. For Install Type, select “Custom or Expand Install” and click “Next”

10. On the ”Select Features” screen, deselect the options for “Web Tier and Server Components”. Only the “Client Components and Database Access” are required. Click “Next” to continue.

11. Click “Next” Once again to start the installation. Please Note the installation may take several minutes to complete.

Configuration

Connecting to CA OnDemand

1. Log into the CA On Demand VPN using the account provided to you

a. CA OnDemand has two VPN servers to support access. West Coast: https://sjcvpn.ondemand.ca.com East Coast: https://sstvpn.ondemand.ca.com

2. Start Network Connect

Prerequisites

1. Get logon information from OnDemand.

a. InfoView logon credentials.

b. Database logon credentials.

c. On Demand VPN logon credentials.

2. Oracle Client 10g or above must be installed. BusinessObjects connects to the database via the

standard oracle OCI connection.

3. Create a TNS Name entry in the TNSNAMES.ORA file. The standard service name is “niku”. For example: niku = (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = <Server IP Address>)(PORT = 1521)) ) (CONNECT_DATA = (SERVICE_NAME = niku) ) ) Step 3 can also be performed using the Oracle Client tool “Net Configuration Assistant” GUI Wizard, which will prompt for the required parameters and create the entry in the local TNSNAMES.ORA file. The Oracle Client “Net Configuration Assistant” tool can also be used to test your connectivity to the database server.

The Oracle Client “Net Manager” can also be used to test database connectivity. In “Net Manager” click on Test Service as shown in the screen shot below and provide database logon credentials provided by On Demand. Make sure you are able to create a successful connection to the database before launching BusinessObjects Designer.

4. Start the Designer program by going to your Program Menu > “BusinessObjects XI 3.1” > “BusinessObjects Enterprise” > “Designer”

System = BusinessObjects Server Username = Use the account information provided for Info View Access Password = Use the password that was provided for Info View Access Authentication = Enterprise

Choose “OK” to log in

Business Object Servers

Environment Server Name

Production <SERVERNAME>

Development <SERVERNAME>

Test <SERVERNAME>

Chapter 7: Crystal Reports

Prerequisites

1. Download the installation file.

a. Note: The file is obtained by requesting it via a CA Support ticket.

b. Select Default install options

2. The following ports must be accessible for this tool:

a. 8443

3. Connection to CA OnDemand VPN.

a. See the "Connecting to CA OnDemand" section from BusinessObjects Designer

4. Oracle Client 10g or above installed.

a. See the "Prerequisites" section from BusinessObjects Designer.

b. Note: For Access to database granted through On Demand ticket. Refer to FAQs.

Test Connection from Crystal Report via Direct SQL 1. Launch Crystal Reports 2008

2. Create a new Blank Report

a. Go to File Menu / New / Blank Report

b. This will automatically launch the Database Expert dialogue box where you can set up a

database connection to use with Crystal Reports.

3. Select Create New Connection and Select Oracle Server.

4. Log in to the database with the Provide credentials.

5. After logging in to the database select “Add Command” which will bring you to the location to

enter direct SQL,

6. In the SQL window create a simple test SQL such as “Select user_name from cmn_sec_users

where rownum <= 10” and Click OK. This SQL should not have schema name prefixes.

7. In Crystal Reports Select View Menu / Field Explorer to view fields available from the SQL

Command to add to the report body.

8. Using the Field Explorer in Crystal Reports under Database Fields / Command, select the

USER_NAME field and add it to the details section of the report via drag and drop.

9. Preview the report results by selecting Preview from the View menu in Crystal Reports.

Chapter 8: Deploying Custom Reports

Introduction After the report is created (including Crystal Reports), the report should be deployed through InfoView

to the “CA Reports -> CA Clarity” folder in CMC (Central Management Console) and then configure the

same in Clarity to view the reports from the application.

Deploying Reports through InfoView 1. Log in to InfoView

2. Click the Document List menu option.

3. Navigate the folder tree to the CA Clarity folder.

4. Click the Add button and choose Crystal Reports” (Alternately, you can right click the mouse and

choose Add->Crystal Reports to add a report.)

5. Click the Choose File button and browse for the report from your local system.

6. Finally, click Ok to add the report.

Deploying Reports through the Central Management Console 1. Login to CMC using the User ID which has access to upload the report, and update the configuration

for the same.

2. After you successfully login, click on All Folders to view the sub-folders

3. Double-click on CA Reports

4. Double-click on CA Clarity.

NOTE: All reports need to be under the CA Clarity Folder. Utilize only this folder for uploads. Do

not create custom directories as they will not be processed during upgrades or migrations.

5. The screen with list of reports will be displayed. These are the reports which are already deployed

under the CA Reports folder. Right click CA Clarity, and then choose Add -> Crystal Reports.

6. Click the Choose File button to choose a report file from your local system.

7. Finally, click Ok to add the report.

Deploying Crystal Reports in Clarity 1. Once the report file is deployed on the server, you will get a screen similar to the one displayed

below. The “Report Title” will be same as the Filename that you upload. You can change the report title

to some meaningful name. The “Report Title” is the one which you will be using in Clarity to reference

the report deployed in CMC. While deploying the reports if the parameter “Show report thumbnail” is

checked, then the thumbnail will be displayed.

2. Expand the Default Settings menu and then click Database Configuration. This will show the database

logon information that you used to create the reports. In many cases the data source name, User ID and

password will be different than what is used by the Clarity admin.

3. Click the option to “Use custom database logon information specified here” and then enter the

following details:

Database Type - Choose the ORACLE database driver.

Server – Specify the name of the entry in your tnsnames.ora (this should be “niku”)

Database – the database schema (user)

User – the user in which to login to the database server

Password – the corresponding password for the User field

Table Prefix – this prefix is used if the user logging in does not have a default schema to

database in which the reports will be run.

These above settings are optional if the database and login properties are not specified in the

report. Generally, the report server will automatically connect to the server. But if the DB

details are hard coded in the report then the auto-bypass will not occur. Completing these

options would be needed at that point.

4. Now that the correct database information, the report can be previewed by right clicking the report

and choosing the View menu option. The report will also invoke correctly when run from Clarity.

Setup New Report definition in Clarity 1. Login to the clarity application and access the Administration menu’s Reports and Jobs option.

2. The following screen will appear after clicking on Reports and Jobs. Click on the button labeled, New.

3. The screen to define a Job Definition will appear. Enter all the details. The Executable Name should

be the name of the report present in CMC and the Active flag should be checked. Click on the button

Save and Exit. This completes the report definition. Now you can view the report in the Clarity

application.

4. Click the Reports and Jobs link under the Home menu.

5. The Reports tab will be selected by default and the section Available Reports will display all the

available reports. Filter the report by entering the name of the report. Use the * wildcard to find any

report with a particular word in it.

i.e.