repository diagnostic tool user guide

Business Intelligence Platform Repository Diagnostic Tool User Guide■ SAP BusinessObjects Business Intelligence platform 4.0 Feature Pack 3

2012-03-19

© 2011 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAPBusinessObjects Explorer, StreamWork, and other SAP products and services mentioned herein as

Copyright

well as their respective logos are trademarks or registered trademarks of SAP AG in Germany andother countries.Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports,Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and servicesmentioned herein as well as their respective logos are trademarks or registered trademarks of BusinessObjects 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 astheir respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAPcompany. All other product and service names mentioned are the trademarks of their respectivecompanies. Data contained in this document serves informational purposes only. National productspecifications may vary.These materials are subject to change without notice. These materials areprovided 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 oromissions with respect to the materials. The only warranties for SAP Group products and servicesare those that are set forth in the express warranty statements accompanying such products andservices, if any. Nothing herein should be construed as constituting an additional warranty.

2012-03-19

Contents

Document History...................................................................................................................5Chapter 1

Repository Diagnostic Tool.....................................................................................................7Chapter 2

Using the Repository Diagnostic Tool.....................................................................................9Chapter 3

To use the Repository Diagnostic Tool.....................................................................................93.1Repository Diagnostic Tool Parameters.................................................................................103.2

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

Inconsistences in the CMS metadata...................................................................................19Chapter 5

More Information...................................................................................................................23Appendix A

Index 27

2012-03-193

2012-03-194

Contents

Document History

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

DescriptionDateVersion

First release of this document.November, 2011SAP BusinessObjects Business Intelligenceplatform 4.0

2012-03-195

Document History

2012-03-196

Document History

Repository Diagnostic Tool

The Repository Diagnostic Tool (RDT) is a command-line tool that scans, diagnoses, and repairsinconsistencies that may occur between your Central Management Server (CMS) system databaseand the File Repository Servers (FRS) filestore, or inconsistencies that can occur in the metadata ofInfoObjects 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 performinga 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 thecorresponding files in the File Repositories. For example, a file that is stored in the FRS may bemissing 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 CMSdatabase. For example, an InfoObject may reference another InfoObject that does not exist in theCMS database.

The RDT peforms 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-03-197


2012-03-198


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 mayoccur 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 againstthe backed-up version while your SAP BusinessObjects Business Intelligence platform services aredown. 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 sepeate 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 CMSdatabase.

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 followingcommand.<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-03-199


2. If you are running the tool on a Unix computer, open a /usr/bin/sh compatible shell, and run thefollowing command..<INSTALLDIR>/sap_bobj/enterprise_xi40/<platform>/boe_reposcan.sh <arguments>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 parametersthat you specify, it either diagnoses and logs inconsistencies, or it repairs inconsistences and logs theaction that it takes.

Repo_Scan_yyyy_mm_dd_hh_mm_ss.xml lists the inconsistencies that the tool finds. If you had thetool repair the discrepancies that it finds, it also creates the file Repo_Repair_yyyy_mm_dd_hh_mm_ss.xml. This file details which objects are repaired and any orpahnedfiles 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 XI4.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\reposcanon 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 findsinconsistencies, see Inconsistences in CMS metadata and Inconsistencies between the CMS and FRS.

Related Topics• Inconsistences 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.

2012-03-1910


Table 3-1: General Parameters

DescriptionOptional orMandatoryParameter

The type of driver used to connect to the CMSdatabase. Accepted values are:• db2databasesubsystem• maxdbdatabasesubsystem• mysqldatabasesubsystem• oracledatabasesubsystem• sqlserverdatabasesubsystem• sybasedatabasesubsystem

Mandatorydbdriver

The connection details that are used to connect tothe CMS database.

For example: -connect"UID=root;PWD=<password>;DSN=<dsn>;HOSTNAME=<hostname>;PORT=<portnumber>"

Mandatoryconnect

Enter the cluster key for your BI platform deploy-ment. For more information on cluster keys see“Securing BI Platform” in the SAP BusinessObjectsBusiness Intelligence Platform Administrator Guide.

Mandatorydbkey

The file path of the Input File Repository Server.

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

Mandatoryinputfrsdir

The file path of the Output File Repository Server.

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

Mandatoryoutputfrsdir

2012-03-1911



The file path where the RDT writes the log files.

The default value is <INSTALLDIR>\SAPBusinessObjects Enterprise XI4.0\reposcan on Windows, and./sap_bobj/enterprise_xi40/reposcan onUnix.

Optionaloutputdir

The number of approximate errors to scan. Thishelps ensure optimum performance. The uppercount is 2e31 - 1. A value of 0 is interpreted as theentire repository.

The default value is 0.

Optionalcount

Tells the RDT to repair all inconsistencies it mayfind. The default behavior is to only report inconsis-tencies but not to perform any repairs. If the -repairparameter exists on the command line, the RDTreports and repairs all inconsistencies.

Caution:This proccess will delete any orphaned objects orfiles in the repository database.

Optionalrepair

Specifies whether the RDT scans the CMS and FRSfor inconsistencies. Acceptable values are True andFalse.

The default value is True.

Optionalscanfrs

Specifies whether the RDT scans the CMS for incon-sistencies between InfoObjects. Acceptable valuesare True and False.

The default value is True.

Optionalscancms

2012-03-1912



Specifies the User ID to replace missing or invalidIDs for scheduled objects. If no value is provided,the RDT does not replace the invalid IDs. If theprovided User ID doesn't exist in the CMS, the RDTprompts for a valid ID.

This parameter is only used when the RDT operatesin repair mode.

Optionalsubmitterid

Specifies the object in the CMS database to startthe scan for. For example, if you've already scannedthe 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.

Optionalstartid

Specifies the file path to a parameter file. The pa-rameter file is a text file that lists each command-line option and its values. The file should have oneparameter per line.

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

Optionaloptionsfile

This parameter is used when you copy the reposito-ry database. You must run the tool on the newlycreated copy, which will update the copy to preventit from clustering with the source system servers. Ifthe copy will not be able to communicate with thesource system, this is not necessary. It should onlybe used with the mandatary parameters and not becombined with other optional parameters in this list.

Note:Be careful not run RDT with the syscopy parameteron your source system.

Optionalsyscopy

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

2012-03-1913


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


The port number that the RDT uses to commu-nicate to the CMS. Accepts whole, positivenumbers. By default, the tool uses the valuefrom the operating system of the machine thatthe RDT is running on.

Optionalrequestport

Whether the RDT uses the numeric IP addressinstead of the hostname for communicationbetween the CMS and the machine that theRDT is running on. Acceptable values are Trueand False.

The default value is False.

Optionalnumericip

The ipv6 name of the machine that the RDT isrunning on. Accepts a string.

The default value is the hostname of the ma-chine that the RDT is running on.

Optionalipv6

The ipv4 name of the machine that the RDT isrunning on. Accepts a string.

The default value is the hostname of the ma-chine that the RDT is running on.

Optionalport

The number of threads to use. Accepts whole,positive numbers.

The default value is 12.Optionalthreads

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

2012-03-1914


Table 3-3: Using the RDT with SSL


Specifies whether the tool should run in SSLmode.

The only accepted value is ssl.Optionalprotocol

The directory that contains the SSL certificates.Optionalssl_certdir

The file name of the certificate.Optionalssl_trustedcertificate

The file name of the signed certificate.Optionalssl_mycertificate

The file name of the file that contains the pri-vate SSL key.Optionalssl_mykey

The file name of the file that contains SSLpassphrase.Optionalssl_mykey_passphrase

Example:

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

2012-03-1915


2012-03-1916


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 DiagnosticTool (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 inthe scan log file.

• Action

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

2012-03-1917


ActionRecommendationInconsistencyWarning Message

The RDT removesthe object from theCMS database.

“Allow the applicationto remove the missingfiles from the object'sfile list.”

The object exists in theCMS database, but thereis no corresponding file inthe FRS.

<Object Name> object<Object Type> (ObjectID: <ID>) is referencingsome files that do not existin the FRS (<File Name>)

When you republishthe file, an object iscreated in the CMSdatabase.

“Please republish thefile. The application willnot publish this file foryou.”

The file exists in the FRS,but there is no correspond-ing file in the CMSdatabase.

<File Name> exists in theInput or Output FRS, butthere is no correspondingInfoObject in the repository.

The RDT updatesthe file size in theCMS database.

“Allow the applicationto update the objectwith the correct filesize.”

The size of the file doesnot match the InfoObjectfile size.

<Object Type> Object<Object Name> (ObjectID <ID>) has a file size<Size>. The stored file sizeis <Size> which does notmatch the actual file size<Size>.

The RDT removesthe empty directory.

“Allow the applicationto remove the directo-ry.”

The FRS folder is empty.<Folder Path> containsno files.

2012-03-1918


Inconsistences in the CMS metadata

The following table describes the inconsistencies that can occur in the metadata of the objects that arein a Central Management Server (CMS) system data base that are recognized by the RepositoryDiagnostic 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 inthe scan log file.

• Action

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

2012-03-1919



The RDT moves the ob-ject and any child objectsto a repair folder. Only theadministrator has accessto this folder.

“Allow RDT to move theobject to the BO Repairfolder. ”

The object has amissing or invalidParent Object ID.

<Object Type> Object<Object Name> (ObjectID: <ObjectName><ID>)'s parent ob-ject is missing (ParentObject ID = <ID>).

The RDT assigns the val-ue of the Administrator'sID to the objects OwnerID.

“Allow the RDT to assignthe object to the Adminis-trator. ”

The object has amissing or invalidOwner Object ID.

<Object Type> Object<Object Name> (ObjectID: <ID>)'s owner objectis missing (Owner ObjectID = <ID>).

If you provide a value fromthe -submitterid parame-ter, the RDT applies thevalue for the object's sub-mitter ID.

If you don't provide a val-ue for this parameter, theRDT takes no action.When you reschedule theobject, the CMS applies anew ID.

The recommendation thatthe RDT displays dependson whether you've provid-ed a value for the -submit-terid parameter.• If you provide this pa-

rameter, the recom-mendation is “Allowthe application to up-date the object withthe provided submitterID”.

• If you don't provide thisparameter, the recom-mendation is “Reschedule the objector submit a user ID touse to replace the in-valid submitter ID”.

The object has amissing or invalidSubmitter Object ID.

<Object Type> Object<Object Name> (ObjectID: <ID>)'s submitter ob-ject is missing (SubmitterObject ID = <ID> ).

When you reschedule theobject, the CMS automati-cally recalculates the ID.

“Allow the application torecalculate the property.”

The object's lastsucessful instanceis missing or invalid.

<Object Type> Object'<Object Name>' (ObjectID: <ID>)'s last success-ful instance propertyrefers to a missing object(Object ID = <ID>).

2012-03-1920



When you reschedule theobject, the CMS applies acalendar to the object.

“Reschedule the objectwith an existing calendar.No action can be taken bythis application.”

The object refer-ences a calendarthat doesn't exist.

<Object Type> Object'<Object Name>' (Ob-ject ID: <ID>)'s calendarobject is missing (Calen-dar ID = <ID>).

When you reschedule theobject, the CMS applies aserver group to the object.

“ Reschedule the objectand choose an existingserver group. No actioncan be taken by this appli-cation.”

The preferred serv-er does not exist.

<Object Type> Object'<Object Name>' (ObjectID: <ID>) 's requiredscheduling server groupis missing (Server GroupObject ID = <ID>)..

The RDT removes themissing events.

“Allow the application toremove the missingevents from the object'slist of events to wait for.”

The event or eventsthat this object iswaiting on does notexist.

<Object Type> Object'<Object Name>' (ObjectID: <ID>)'s list of eventsto wait for contains miss-ing object(s) (Object ID(s)= <ID>).

The RDT removes themissing events.

“Allow the application toremove the missingevents from the object'slist of events to trigger.”

This object triggersan event that doesnot exist.

<Object Type> Object'<Object Name>' (ObjectID: <ID>)'s list of eventsto trigger contains missingobject(s) (Object ID(s) =<ID>).

2012-03-1921



The RDT removes themissing principal(s).

“ Allow the application toremove the missing princi-pal(s) from the object'sAccess Control List.”

Orphaned AccessControl entry.

<Object Type> Object'<Object Name>' (ObjectID: <ID>) Access ControlList references a missingprincipal (Object ID =<ID>).

The RDT removes the ob-jects missing entries fromthe object's server grouplist.

“Allow the tool to removethe object's invalid entriesfrom its Server Group list.”

The preferred serv-er does not exist.

<Object Type> Object'<Object Name>' (ObjectID: <ID>) has invalidServer Group entries<Server GroupEntries>.

The RDT consolidates theuser's Favorites foldersinto a single folder.

“Allow the application toconsolidate multiple Fa-vorites folders into a sin-gle Favorites folder.”

A specific user ac-count has multiplefavorites folders.

<Object Type> Object<Object Name> (ObjectID: <ID>) has multipleFavorites folders.

2012-03-1922


More Information

LocationInformation Resource

http://www.sap.comSAP product information

http://help.sap.com/businessobjects

Access the most up-to-date English documentation covering all SAPBusinessObjects products at the SAP Help Portal:http://help.sap.com/bobi (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 SAPService Marketplace. Customers with a maintenance agreement havean authorized user ID to access this site. To obtain an ID, contact yourcustomer support representative.To find a comprehensive list of product documentation in all supportedlanguages, visit:http://help.sap.com/boall.

SAP Help Portal

2012-03-1923

More Information

http://www.sap.com

http://help.sap.com/businessobjects

http://help.sap.com/bobi

http://help.sap.com/boepm

http://help.sap.com/boeim

http://help.sap.com/boall


http://service.sap.com/bosap-support

The SAP Support Portal contains information about Customer Supportprograms and services. It also has links to a wide range of technical in-formation and downloads. Customers with a maintenance agreementhave an authorized user ID to access this site. To obtain an ID, contactyour customer support representative.[Sean McGregor - Feb 2012] [Updating this More Information page toalign with new help portal goals. Product pages on help.sap.com nowcontain links to release notes, install guides, PAM, and other supportportal materials so I've removed all this content below and merged the"Online customer support" row that previously existed at the bottom intothis row which had the same URL above.]• Installation guides: https://service.sap.com/bosap-instguides• Release notes: http://service.sap.com/releasenotes

The SAP Service Marketplace stores certain installation guides, upgradeand migration guides, deployment guides, release notes and SupportedPlatforms documents. Customers with a maintenance agreement havean authorized user ID to access this site. Contact your customer supportrepresentative to obtain an ID. If you are redirected to the SAP ServiceMarketplace from the SAP Help Portal, use the menu in the navigationpane on the left to locate the category containing the documentation youwant to access.

SAP Support Portal

http://www.sdn.sap.com/irj/sdn/bi-sdk-dev

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibraryDeveloper resources

http://www.sdn.sap.com/irj/boc/articles

These articles were formerly known as technical papers.SAP BusinessObjects articles onthe SAP Community Network

https://service.sap.com/notes

These notes were formerly known as Knowledge Base articles.Notes

https://www.sdn.sap.com/irj/scn/forumsForums on the SAP CommunityNetwork

http://www.sap.com/services/education

From traditional classroom learning to targeted e-learning seminars, wecan offer a training package to suit your learning needs and preferredlearning style.

Training

2012-03-1924

More Information

http://service.sap.com/bosap-support

https://service.sap.com/bosap-instguides

http://service.sap.com/releasenotes

http://www.sdn.sap.com/irj/sdn/bi-sdk-dev

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary

http://www.sdn.sap.com/irj/boc/articles

https://service.sap.com/notes

https://www.sdn.sap.com/irj/scn/forums

http://www.sap.com/services/education


http://www.sap.com/services/bysubject/businessobjectsconsulting

Consultants can accompany you from the initial analysis stage to thedelivery of your deployment project. Expertise is available in topics suchas relational and multidimensional databases, connectivity, databasedesign tools, and customized embedding technology.

Consulting

2012-03-1925

More Information

http://www.sap.com/services/bysubject/businessobjectsconsulting

2012-03-1926

More Information

IndexD

document history 5 R

repository diagnostic toolinconsistencies

diagnose and repair 7object to file 7scenarios 7

repository diagnostic tool (continued)overview 7parameters 9table of inconsistencies

recommendations 17, 19using

Windows and Unix 9

2012-03-1927

2012-03-1928

Index

repository diagnostic tool user guide

Documents

sap products

sap company

sap netweaver

sap group products

sap businessobjects

business objects products

sybase products

affiliated companies