Business Intelligence Platform Repository Diagnostic Tool User Guide

SAP BusinessObjects Business Intelligence platform 4.0 Support Package 4

2012-11-08

Copyright

2012 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP
BusinessObjects Explorer, StreamWork, SAP HANA and other SAP products and services mentioned
herein as well as their respective logos are trademarks or registered trademarks of SAP AG in
Germany and other countries.Business Objects and the Business Objects logo, BusinessObjects,
Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products
and services mentioned herein as well as their respective logos are trademarks or registered
trademarks of Business Objects Software Ltd. Business Objects is an SAP company.Sybase and
Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services
mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase,
Inc. Sybase is an SAP company. Crossgate, m@gic EDDY, B2B 360, B2B 360 Services are
registered trademarks of Crossgate AG in Germany and other countries. Crossgate is an SAP
company. All other product and service names mentioned are the trademarks of their respective
companies. Data contained in this document serves informational purposes only. National product
specifications may vary.These materials are subject to change without notice. These materials are
provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only,
without representation or warranty of any kind, and SAP Group shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP Group products and services
are those that are set forth in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an additional warranty.
2012-11-08

Contents

Chapter 1

Document History...................................................................................................................5

Chapter 2

Repository Diagnostic Tool.....................................................................................................7

Chapter 3

Using the Repository Diagnostic Tool.....................................................................................9

3.1
3.2

To use the Repository Diagnostic Tool.....................................................................................9

Chapter 4

Inconsistencies between the CMS and the FRS...................................................................17

Chapter 5

Inconsistencies in the CMS metadata..................................................................................19

Appendix A

More Information...................................................................................................................23

Index

Repository Diagnostic Tool Parameters.................................................................................10

25

2012-11-08

Contents

2012-11-08

Document History

Document History

The following table provides an overview of the most important document changes.
Version

Date

Description

SAP BusinessObjects Business Intelli- November, First release of this document.

gence platform 4.0
2011
SAP BusinessObjects Business Intelli- August
gence platform 4.0 Feature Pack 3
2012

Added a SQL Anywhere database type as an allowable value for the dbdriver parameter.

2012-11-08

Document History

2012-11-08

Repository Diagnostic Tool

Repository Diagnostic Tool

The Repository Diagnostic Tool (RDT) is a command-line tool that scans, diagnoses, and repairs
inconsistencies that may occur between your Central Management Server (CMS) system database
and the File Repository Servers (FRS) filestore, or inconsistencies that can occur in the metadata of
InfoObjects stored in the CMS database.
During normal operations, it is unusual for the CMS system database to have inconsistencies. However,
inconsistencies may occur during unexpected events such as disaster recovery, back-up restoration,
or network outages. During these events, the CMS system database may be interrupted while performing
a task. This can cause inconsistencies with objects in the CMS system database.
The RDT scans the CMS system database and identifies inconsistencies in such objects as reports,
users, user groups, folders, servers, universes, universe connections, and other objects.
The RDT scans for two types of inconsistencies.

Object to file inconsistencies.

These are inconsistencies that can occur between InfoObjects in the CMS database and the
corresponding files in the File Repositories. For example, a file that is stored in the FRS may be
missing a corresponding object in the CMS system database.

InfoObject metadata inconsistencies.

These are inconsistencies that may exist in an InfoObject's object definition (metadata) in the CMS
database. For example, an InfoObject may reference another InfoObject that does not exist in the
CMS database.

The RDT performs two functions, depending on the parameters that you provide when you run the tool:

It scans the CMS system database and FRS filestore, reports inconsistencies, and outputs a log file
in XML format with suggested actions to repair the inconsistencies.
It scans and repairs the inconsistencies identified in the CMS system database and FRS, and outputs
the actions taken to a log file in XML format.

2012-11-08

Repository Diagnostic Tool

2012-11-08

Using the Repository Diagnostic Tool

Using the Repository Diagnostic Tool

The Repository Diagnostic Tool (RDT) is available on any machine with a Central Configuration Manager
(CCM) installed on it. This command-line tool scans, diagnoses, and repairs inconsistencies that may
occur between the Central Management Server (CMS) system database and the File Repository Servers
(FRS) filestore, or inconsistencies that may occur in an InfoObject's metadata.
It is recommended that you back up your CMS database and FRS filestore, and run the RDT against
the backed-up version while your SAP BusinessObjects Business Intelligence platform services are
down. If this is not possible, RDT can be run on an active database.
If you want to run RDT on an active database please keep the following considerations in mind:
RDT will use one database connection while it runs.
The RDT will only check the consistency of the database to the point in time where it started running.
Any inconsistencies that occur while the RDT is running will not be logged or fixed.
It is recommended that the host machine running RDT have memory above the normal system
recommendations available for processing RDT transactions:
A database of 50,000 info objects or less should have an additional 350 Mb available for
processing
A database of 50,000 to 400,000 info objects should have an additional 1.7 Gb available for
processing
A database of 400,000 to 1,000,000 info objects should have an additional 4 Gb available for
processing

RDT does not have to be run from your CMS server, running it on a separate machine can help
reduce any impact on system performance.
The tool may have a moderate impact on database performance while being run.

The RDT does not require the CMS service to be running, the RDT runs directly against the CMS
database.

3.1 To use the Repository Diagnostic Tool

1. If you are running the tool on a Windows computer, open a command window and run the following
command.
<INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\win64_x64\reposcan.exe
<arguments>, where <arguments> is the list of parameters that you want to specify.

2012-11-08

Using the Repository Diagnostic Tool

2. If you are running the tool on a Unix computer, open a /usr/bin/sh compatible shell, and run the
following command.
.<INSTALLDIR>/sap_bobj/enterprise_xi40/<platform>/boe_reposcan.sh <argu
ments> where <platform> is either linux_x64, solaris_sparcv9, hpux_ia64, or aix_rs6000_64,
and <arguments> is the list of parameters that you want to specify.
The Repository Diagnostic Tool scans your repository for inconsistencies. Depending on the parameters
that you specify, it either diagnoses and logs inconsistencies, or it repairs inconsistences and logs the
action that it takes.
Repo_Scan_yyyy_mm_dd_hh_mm_ss.xml lists the inconsistencies that the tool finds. If you had the
tool repair the discrepancies that it finds, it also creates the file Repo_Re
pair_yyyy_mm_dd_hh_mm_ss.xml. This file details which objects are repaired and any orphaned
files that were deleted. If there are inconsistencies that could not be repaired these will also be listed.
The path to the log files can be specified by the outputdir parameter. If this parameter is not specified,
the default directory for the log files is <INSTALLDIR>\SAP BusinessObjects Enterprise XI
4.0\reposcan on Windows, and ./sap_bobj/enterprise_xi40/reposcan on Unix.
Note:
The application also provides a default XSL file that is used with the XML file to produce an HTML page.
The XSL file is stored in <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\reposcan
on Windows, and ./sap_bobj/enterprisexi_40/reposcan on Unix
For a list of the warning messages and recommended actions that the RDT takes when it finds
inconsistencies, see Inconsistences in CMS metadata and Inconsistencies between the CMS and FRS
.
Related Topics
Inconsistencies in the CMS metadata
Inconsistencies between the CMS and the FRS

3.2 Repository Diagnostic Tool Parameters

The RDT accepts the parameters in the following table:
Note:
Command-line arguments override any parameter file entries while executing.

10

2012-11-08

Using the Repository Diagnostic Tool

Table 3-1: General Parameters

Parameter

dbdriver

Optional or
Mandatory

Description

Mandatory

The type of driver used to connect to the CMS

database. Accepted values are:
db2databasesubsystem
maxdbdatabasesubsystem
mysqldatabasesubsystem
oracledatabasesubsystem
sqlserverdatabasesubsystem
sybasedatabasesubsystem
sqlanywheredatabasesubsystem

The connection details that are used to connect to

the CMS database.
connect

dbkey

Mandatory

Mandatory

For example: -connect

"UID=root;PWD=<pass
word>;DSN=<dsn>;HOSTNAME=<host
name>;PORT=<portnumber>"
Enter the cluster key for your BI platform deployment. For more information on cluster keys see
Securing BI Platform in the SAP BusinessObjects
Business Intelligence Platform Administrator Guide.
The file path of the Input File Repository Server.

inputfrsdir

Mandatory

Note:
The user account you are logged on with is used to
execute the command-line tool. It must have full
control to the file location.

The file path of the Output File Repository Server.

outputfrsdir

11

Mandatory

Note:
The user account you are logged on with is used to
execute the command-line tool. It must have full
control to the file location.

2012-11-08

Using the Repository Diagnostic Tool

Parameter

Optional or
Mandatory

Description

The file path where the RDT writes the log files.

outputdir

count

Optional

Optional

The default value is <INSTALLDIR>\SAP

BusinessObjects Enterprise XI
4.0\reposcan on Windows, and
./sap_bobj/enterprise_xi40/reposcan on
Unix.
The number of approximate errors to scan. This
helps ensure optimum performance. The upper
count is 2e31 - 1. A value of 0 is interpreted as the
entire repository.
The default value is 0.

repair

Optional

Tells the RDT to repair all inconsistencies it may

find. The default behavior is to only report inconsistencies but not to perform any repairs. If the -repair
parameter exists on the command line, the RDT
reports and repairs all inconsistencies.
Caution:
This process will delete any orphaned objects or
files in the repository database.

scanfrs

Optional

Specifies whether the RDT scans the CMS and FRS

for inconsistencies. Acceptable values are True and
False.
The default value is True.

scancms

Optional

Specifies whether the RDT scans the CMS for inconsistencies between InfoObjects. Acceptable values
are True and False.
The default value is True.

12

2012-11-08

Using the Repository Diagnostic Tool

Parameter

submitterid

Optional or
Mandatory

Optional

Description

Specifies the User ID to replace missing or invalid

IDs for scheduled objects. If no value is provided,
the RDT does not replace the invalid IDs. If the
provided User ID doesn't exist in the CMS, the RDT
prompts for a valid ID.
This parameter is only used when the RDT operates
in repair mode.

startid

Optional

Specifies the object in the CMS database to start

the scan for. For example, if you've already scanned
the first 500 objects in your repository, you can set
-startid=501 to start a new scan at the 501st object.
The default value is 1.
Specifies the file path to a parameter file. The parameter file is a text file that lists each commandline option and its values. The file should have one
parameter per line.

optionsfile

syscopy

Optional

Optional

Note:
With this option, you can set all parameters in a Text
file as described above. Use this option to point to
the parameter file without entering the parameters
on the command-line.

This parameter is used when you copy the repository database. You must run the tool on the newly
created copy, which will update the copy to prevent
it from clustering with the source system servers. If
the copy will not be able to communicate with the
source system, this is not necessary. It should only
be used with the mandatary parameters and not be
combined with other optional parameters in this list.
Note:
Be careful not to run the RDT with the syscopy parameter on your source system.

The following parameters are used if the Repository Diagnostic Tool is running on an active clustered
CMS.

13

2012-11-08

Using the Repository Diagnostic Tool

Table 3-2: Using the RDT against a clustered CMS

Parameter

requestport

numericip

Optional or
Mandatory

Description

Optional

The port number that the RDT uses to communicate to the CMS. Accepts whole, positive
numbers. By default, the tool uses the value
from the operating system of the machine that
the RDT is running on.

Optional

Whether the RDT uses the numeric IP address

instead of the hostname for communication
between the CMS and the machine that the
RDT is running on. Acceptable values are True
and False.
The default value is False.
The ipv6 name of the machine that the RDT is
running on. Accepts a string.

ipv6

Optional
The default value is the hostname of the machine that the RDT is running on.
The ipv4 name of the machine that the RDT is
running on. Accepts a string.

port

Optional
The default value is the hostname of the machine that the RDT is running on.

threads

Optional

The number of threads to use. Accepts whole,

positive numbers.
The default value is 12.

The following parameters are used when the RDT uses SSL to communicate with the CMS database
that it scans.

14

2012-11-08

Using the Repository Diagnostic Tool

Table 3-3: Using the RDT with SSL

Parameter

protocol

Optional or
Mandatory

Optional

Description

Specifies whether the tool should run in SSL

mode.
The only accepted value is ssl.

ssl_certdir

Optional

The directory that contains the SSL certificates.

ssl_trustedcertificate

Optional

The file name of the certificate.

ssl_mycertificate

Optional

The file name of the signed certificate.

ssl_mykey

Optional

The file name of the file that contains the private SSL key.

ssl_mykey_passphrase

Optional

The file name of the file that contains SSL

passphrase.

Example:
The following example scans the CMS and FRS for both kinds of inconsistencies, and repairs the
inconsistencies that it finds.
reposcan.exe
-dbdriver mysqldatabasesubsystem
-connect UID=root;PWD=Password1;DSN=myDsn;HOSTNAME=myHostname;PORT=3306
-dbkey <cluster key>
-repair
-inputfrsdirC:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\FileStore\Input
-outputfrsdir C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI
4.0\FileStore\Output

15

2012-11-08

Using the Repository Diagnostic Tool

16

2012-11-08

Inconsistencies between the CMS and the FRS

Inconsistencies between the CMS and the FRS

The following table describes the inconsistencies that may between a Central Management Server
(CMS) data base and the File Repository Servers (FRS) that are recognized by the Repository Diagnostic
Tool (RDT). The table has 4 columns:
Warning Message
The warning message that is written to the scan and repair log files.

Inconsistency
An explanation of the inconsistency that the RDT finds for the object.

Recommendation
The recommended action that the RDT should take when it finds an inconsistency. This is found in
the scan log file.

Action
The action that the RDT takes to repair an inconsistency. This is found in the repair log file.

17

2012-11-08

Inconsistencies between the CMS and the FRS

Warning Message

Recommendation

Action

The object exists in the

<Object Name> object
CMS database, but there
<Object Type> (Object
is no corresponding file in
ID: <ID>) is referencing
the FRS.
some files that do not exist
in the FRS (<File Name>)

Allow the application The RDT removes

to remove the missing the object from the
files from the object's CMS database.
file list.

The file exists in the FRS,

<File Name> exists in the
but there is no correspondInput or Output FRS, but
ing file in the CMS
there is no corresponding
database.
InfoObject in the repository.

Please republish the

file. The application will
not publish this file for
you.

When you republish

the file, an object is
created in the CMS
database.

The size of the file does

<Object Type> Object
not match the InfoObject
<Object Name> (Object
file size.
ID <ID>) has a file size
<Size>. The stored file size
is <Size> which does not
match the actual file size
<Size>.

Allow the application

to update the object
with the correct file
size.

The RDT updates

the file size in the
CMS database.

<Folder Path> contains

no files.

18

Inconsistency

The FRS folder is empty. Allow the application The RDT removes
to remove the directo- the empty directory.
ry.

2012-11-08

Inconsistencies in the CMS metadata

Inconsistencies in the CMS metadata

The following table describes the inconsistencies that can occur in the metadata of the objects that are
in a Central Management Server (CMS) system data base that are recognized by the Repository
Diagnostic Tool (RDT). The table has 4 columns:
Warning Message
The warning message that is written to the scan and repair log files.

Inconsistency
An explanation of the inconsistency that the RDT finds for the object.

Recommendation
The recommended action that the RDT should take when it finds an inconsistency. This is found in
the scan log file.

Action
The action that the RDT takes to repair an inconsistency. This is found in the repair log file.

19

2012-11-08

Inconsistencies in the CMS metadata

Warning Message

Inconsistency

Recommendation

Action

<Object Type> Object The object has a

<Object Name> (Object missing or invalid
Parent Object ID.
ID: <Object
Name><ID>)'s parent object is missing (Parent
Object ID = <ID>).

Allow RDT to move the The RDT moves the obobject to the BO Repair ject and any child objects
to a repair folder. Only the
folder.
administrator has access
to this folder.

<Object Type> Object The object has a

<Object Name> (Object missing or invalid
ID: <ID>)'s owner object Owner Object ID.
is missing (Owner Object
ID = <ID>).

Allow the RDT to assign The RDT assigns the valthe object to the Adminis- ue of the Administrator's
trator.
ID to the objects Owner
ID.

<Object Type> Object The object has a

<Object Name> (Object missing or invalid
ID: <ID>)'s submitter ob- Submitter Object ID.
ject is missing (Submitter
Object ID = <ID> ).

The recommendation that

the RDT displays depends
on whether you've provided a value for the -submitterid parameter.
If you provide this parameter, the recommendation is Allow
the application to update the object with
the provided submitter
ID.
If you don't provide this
parameter, the recommendation is
Reschedule the object
or submit a user ID to
use to replace the invalid submitter ID.

If you provide a value from

the -submitterid parameter, the RDT applies the
value for the object's submitter ID.
If you don't provide a value for this parameter, the
RDT takes no action.
When you reschedule the
object, the CMS applies a
new ID.

<Object Type> Object The object's last

Allow the application to When you reschedule the
'<Object Name>' (Object successful instance recalculate the property. object, the CMS automatically recalculates the ID.
ID: <ID>)'s last success- is missing or invalid.
ful instance property
refers to a missing object
(Object ID = <ID>).

20

2012-11-08

Inconsistencies in the CMS metadata

Warning Message

21

Inconsistency

Recommendation

Action

<Object Type> Object The object refer'<Object Name>' (Ob- ences a calendar
ject ID: <ID>)'s calendar that doesn't exist.
object is missing (Calendar ID = <ID>).

Reschedule the object

When you reschedule the
with an existing calendar. object, the CMS applies a
No action can be taken by calendar to the object.
this application.

<Object Type> Object The preferred serv'<Object Name>' (Object er does not exist.
ID: <ID>) 's required
scheduling server group
is missing (Server Group
Object ID = <ID>)..

Reschedule the object When you reschedule the

and choose an existing
object, the CMS applies a
server group. No action server group to the object.
can be taken by this application.

<Object Type> Object

'<Object Name>' (Object
ID: <ID>)'s list of events
to wait for contains missing object(s) (Object ID(s)
= <ID>).

The event or events

that this object is
waiting on does not
exist.

Allow the application to

remove the missing
events from the object's
list of events to wait for.

The RDT removes the

missing events.

<Object Type> Object This object triggers

'<Object Name>' (Object an event that does
ID: <ID>)'s list of events not exist.
to trigger contains missing
object(s) (Object ID(s) =
<ID>).

Allow the application to

remove the missing
events from the object's
list of events to trigger.

The RDT removes the

missing events.

2012-11-08

Inconsistencies in the CMS metadata

Warning Message

Inconsistency

<Object Type> Object Orphaned Access

'<Object Name>' (Object Control entry.
ID: <ID>) Access Control
List references a missing
principal (Object ID =
<ID>).

22

Recommendation

Action

Allow the application to The RDT removes the

remove the missing princi- missing principal(s).
pal(s) from the object's
Access Control List.

<Object Type> Object The preferred serv- Allow the tool to remove
the object's invalid entries
'<Object Name>' (Object er does not exist.
from its Server Group list.
ID: <ID>) has invalid
Server Group entries
<Server Group
Entries>.

The RDT removes the objects missing entries from

the object's server group
list.

<Object Type> Object A specific user ac<Object Name> (Object count has multiple
favorites folders.
ID: <ID>) has multiple
Favorites folders.

The RDT consolidates the

user's Favorites folders
into a single folder.

Allow the application to

consolidate multiple Favorites folders into a single Favorites folder.

2012-11-08

More Information

More Information

Information Resource

Location

SAP product information

http://www.sap.com
http://help.sap.com/analytics

SAP Help Portal

Access the most up-to-date English documentation covering all SAP

Analytics products at the SAP Help Portal:
http://help.sap.com/bobi (BusinessObjects Business Intelligence)
http://help.sap.com/boepm (Enterprise Performance Management)
http://help.sap.com/boeim (Enterprise Information Management)
Certain guides linked to from the SAP Help Portal are stored on the SAP
Service Marketplace. Customers with a maintenance agreement have
an authorized user ID to access this site. To obtain an ID, contact your
customer support representative.
To find a comprehensive list of product documentation in all supported
languages, visit:http://help.sap.com/boall.
http://service.sap.com/bosap-support

SAP Support Portal

The SAP Support Portal contains information about Customer Support

programs and services. It also has links to a wide range of technical information and downloads. Customers with a maintenance agreement
have an authorized user ID to access this site. To obtain an ID, contact
your customer support representative.
http://www.sdn.sap.com/irj/sdn/bi-sdk-dev

Developer resources
http://scn.sap.com/docs/DOC-27465 (BI SDK Developer Library)

Articles and eLearning on the SAP

Community Network

23

http://scn.sap.com/docs/DOC-19311
These articles were formerly known as technical papers.

2012-11-08

More Information

Information Resource

Location

https://service.sap.com/notes
Notes
These notes were formerly known as Knowledge Base articles.
Forums on the SAP Community
Network

https://www.sdn.sap.com/irj/scn/forums
http://www.sap.com/services/education

Training

From traditional classroom learning to targeted e-learning seminars, we

can offer a training package to suit your learning needs and preferred
learning style.
http://www.sap.com/services/bysubject/businessobjectsconsulting

Consulting

24

Consultants can accompany you from the initial analysis stage to the
delivery of your deployment project. Expertise is available in topics such
as relational and multidimensional databases, connectivity, database
design tools, and customized embedding technology.

2012-11-08

Index
D
document history 5

R
repository diagnostic tool
inconsistencies
diagnose and repair 7
object to file 7
scenarios 7

25

repository diagnostic tool (continued)

overview 7
parameters 9
table of inconsistencies
recommendations 17, 19
using
Windows and Unix 9

2012-11-08

Index

26

2012-11-08